( )⚙ D10020 debian: support a "chg-first" installation mechanism (hg is actually chg)

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D10020

debian: support a "chg-first" installation mechanism (hg is actually chg)
ClosedPublic

Authored by spectral on Feb 18 2021, 6:35 PM.

Details

Reviewers
yuja
durin42
Group Reviewers
hg-reviewers
Commits
rHG90481550467c: debian: support a "chg-first" installation mechanism (hg is actually chg)
Summary

This mechanism builds chg such that it looks for hg to be available at
/usr/lib/mercurial/hg instead of in the $PATH as hg, and makes the hg in
/usr/bin be a symlink to chg.

It's important to note that the hg binary must continue to be named hg. If we
wanted to instead place it at /usr/bin/pyhg or something similar, we would need
to modify Mercurial to allow that basename. Failure to do so would break
Mercurial's shell aliases that use hg, chg, or $HG.

I don't know if we should ever have a setup like this be the default setup, but
I'm willing to get more information on our experience with it for making such a
determination. Actually making it the default might be rather involved, as we
don't maintain the official debian packaging rules.

Diff Detail

Repository
rHG Mercurial
Branch
default
Lint
No Linters Available
Unit
No Unit Test Coverage

Event Timeline

spectral created this revision.Feb 18 2021, 6:35 PM
spectral added a reviewer: yuja.Feb 22 2021, 3:30 PM

Adding yuja as an explicit reviewer.

durin42 accepted this revision as: durin42.Feb 24 2021, 11:01 AM
durin42 added a subscriber: durin42.

AFAICT this should be fine, but I'll give Yuya a while to catch problems.

spectral added a commit: rHG90481550467c: debian: support a "chg-first" installation mechanism (hg is actually chg).Mar 4 2021, 7:38 AM
This revision was not accepted when it landed; it landed in state Needs Review.
Closed by commit rHG90481550467c: debian: support a "chg-first" installation mechanism (hg is actually chg) (authored by spectral). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mcontrib/packaging/debian/rules (15 lines)

Diff 25658

contrib/packaging/debian/rules

# If you choose `DEB_HG_MULTI_VERSION=1`, it will build for every "supported" # If you choose `DEB_HG_MULTI_VERSION=1`, it will build for every "supported"
# version of py3 that's installed on the build machine. This may not be equal to # version of py3 that's installed on the build machine. This may not be equal to
# the actual versions that are installed, see the comment above where we set # the actual versions that are installed, see the comment above where we set
# DEB_HG_PYTHON_VERSIONS below. If you choose to set `DEB_HG_PYTHON_VERSIONS` # DEB_HG_PYTHON_VERSIONS below. If you choose to set `DEB_HG_PYTHON_VERSIONS`
# yourself, set it to a space-separated string of python version numbers, like: # yourself, set it to a space-separated string of python version numbers, like:
# DEB_HG_PYTHON_VERSIONS="3.7 3.8" make deb # DEB_HG_PYTHON_VERSIONS="3.7 3.8" make deb
DEB_HG_MULTI_VERSION?=0 DEB_HG_MULTI_VERSION?=0
# Set to 1 to make /usr/bin/hg a symlink to chg, and move hg to
# /usr/lib/mercurial/hg.
DEB_HG_CHG_BY_DEFAULT?=0
CPUS=$(shell cat /proc/cpuinfo | grep -E ^processor | wc -l) CPUS=$(shell cat /proc/cpuinfo | grep -E ^processor | wc -l)
# By default, only build for the version of python3 that the system considers # By default, only build for the version of python3 that the system considers
# the 'default' (which should be the one invoked by just running 'python3' # the 'default' (which should be the one invoked by just running 'python3'
# without a minor version). If DEB_HG_PYTHON_VERSIONS is set, this is ignored. # without a minor version). If DEB_HG_PYTHON_VERSIONS is set, this is ignored.
ifeq ($(DEB_HG_MULTI_VERSION), 1) ifeq ($(DEB_HG_MULTI_VERSION), 1)
# If we're building for multiple versions, use all of the "supported" versions # If we're building for multiple versions, use all of the "supported" versions
# on the build machine. Note: the mechanism in use here (`py3versions`) is the # on the build machine. Note: the mechanism in use here (`py3versions`) is the
# recommended one, but it relies on a file written by the python3-minimal # recommended one, but it relies on a file written by the python3-minimal
# package, and this file is not dynamic and does not account for manual # package, and this file is not dynamic and does not account for manual
# installations, just the ones that would be installed by `python3-all`. This # installations, just the ones that would be installed by `python3-all`. This
# includes the `-i` flag, which claims it's to list all "installed" versions, # includes the `-i` flag, which claims it's to list all "installed" versions,
# but it doesn't. This was quite confusing, hence this tale of woe. :) # but it doesn't. This was quite confusing, hence this tale of woe. :)
DEB_HG_PYTHON_VERSIONS?=$(shell py3versions -vs) DEB_HG_PYTHON_VERSIONS?=$(shell py3versions -vs)
else else
# If we're building for only one version, identify the "default" version on # If we're building for only one version, identify the "default" version on
# the build machine and use that when building; this is just so that we don't # the build machine and use that when building; this is just so that we don't
# have to duplicate the rules below for multi-version vs. single-version. The # have to duplicate the rules below for multi-version vs. single-version. The
# shebang line will still be /usr/bin/python3 (no minor version). # shebang line will still be /usr/bin/python3 (no minor version).
DEB_HG_PYTHON_VERSIONS?=$(shell py3versions -vd) DEB_HG_PYTHON_VERSIONS?=$(shell py3versions -vd)
endif endif
ifeq ($(DEB_HG_CHG_BY_DEFAULT), 1)
# Important: the "real" hg must have a 'basename' of 'hg'. Otherwise, hg
# behaves differently when setting $HG and breaks aliases that use that.
export HGPATH=/usr/lib/mercurial/hg
endif
export HGPYTHON3=1 export HGPYTHON3=1
export PYTHON=python3 export PYTHON=python3
%: %:
dh $@ --with python3 dh $@ --with python3
# Note: testing can be disabled using the standard `DEB_BUILD_OPTIONS=nocheck` # Note: testing can be disabled using the standard `DEB_BUILD_OPTIONS=nocheck`
override_dh_auto_test: override_dh_auto_test:
cp contrib/hgk "$(CURDIR)"/debian/mercurial/usr/share/mercurial cp contrib/hgk "$(CURDIR)"/debian/mercurial/usr/share/mercurial
mkdir -p "$(CURDIR)"/debian/mercurial/etc/mercurial/hgrc.d/ mkdir -p "$(CURDIR)"/debian/mercurial/etc/mercurial/hgrc.d/
cp contrib/packaging/debian/*.rc "$(CURDIR)"/debian/mercurial/etc/mercurial/hgrc.d/ cp contrib/packaging/debian/*.rc "$(CURDIR)"/debian/mercurial/etc/mercurial/hgrc.d/
# completions # completions
mkdir -p "$(CURDIR)"/debian/mercurial/usr/share/bash-completion/completions mkdir -p "$(CURDIR)"/debian/mercurial/usr/share/bash-completion/completions
cp contrib/bash_completion "$(CURDIR)"/debian/mercurial/usr/share/bash-completion/completions/hg cp contrib/bash_completion "$(CURDIR)"/debian/mercurial/usr/share/bash-completion/completions/hg
mkdir -p "$(CURDIR)"/debian/mercurial/usr/share/zsh/vendor-completions mkdir -p "$(CURDIR)"/debian/mercurial/usr/share/zsh/vendor-completions
cp contrib/zsh_completion "$(CURDIR)"/debian/mercurial/usr/share/zsh/vendor-completions/_hg cp contrib/zsh_completion "$(CURDIR)"/debian/mercurial/usr/share/zsh/vendor-completions/_hg
if [[ "$(DEB_HG_CHG_BY_DEFAULT)" -eq 1 ]]; then \
mkdir -p "$(CURDIR)"/debian/mercurial/usr/lib/mercurial; \
mv "$(CURDIR)"/debian/mercurial/usr/bin/hg "$(CURDIR)"/debian/mercurial/usr/lib/mercurial/hg; \
ln -s chg "$(CURDIR)"/debian/mercurial/usr/bin/hg; \
fi