This is an archive of the discontinued Mercurial Phabricator instance.

Differential D9640

setup: when possible, build and bundle man pages
ClosedPublic

Authored by danchr on Dec 21 2020, 11:11 AM.

Details

Reviewers
marmoute
Group Reviewers
hg-reviewers
Commits
rHG63c923fd7fa8: setup: when possible, build and bundle man pages
Summary

This makes it so the manual pages are built as part of the Python
build, and includes them in any wheel generated. This should make
Python wheels a much more useful and complete way of distributing
Mercurial binaries.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

danchr created this revision.Dec 21 2020, 11:11 AM
marmoute accepted this revision.Jan 8 2021, 11:00 AM
marmoute added a subscriber: marmoute.

This looks good.

setup.py
484

small nits: you are checking for None so use is not None please.

danchr updated this revision to Diff 24698.Jan 9 2021, 10:27 PM
danchr marked an inline comment as done.Jan 9 2021, 10:29 PM
In D9640#146337, @marmoute wrote:

This looks good.

I should note that I didn't remove the current infrastructure that builds the documentation in the Makefile.

setup.py
484

Done.

danchr edited the summary of this revision. (Show Details)Jan 12 2021, 7:07 AM
danchr added a child revision: D9722: setup: don't import distutils prior to checking FORCE_SETUPTOOLS.
danchr updated this revision to Diff 24712.
Dan Villiom Podlaski Christiansen <danchr@gmail.com> added a commit: rHG63c923fd7fa8: setup: when possible, build and bundle man pages.Jan 13 2021, 2:40 PM
This revision was not accepted when it landed; it landed in state Needs Review.
Closed by commit rHG63c923fd7fa8: setup: when possible, build and bundle man pages (authored by Dan Villiom Podlaski Christiansen <danchr@gmail.com>). · Explain Why
This revision was automatically updated to reflect the committed changes.
danchr added a comment.Jan 15 2021, 7:48 AM

This breaks the build; could you please unapply it while I investigate?

Revision Contents
Changeset List

PathPackages
Msetup.py (64 lines)

Diff 24802

setup.py

from distutils.ccompiler import new_compiler from distutils.ccompiler import new_compiler
from distutils.core import Command, Extension from distutils.core import Command, Extension
from distutils.dist import Distribution from distutils.dist import Distribution
from distutils.command.build import build from distutils.command.build import build
from distutils.command.build_ext import build_ext from distutils.command.build_ext import build_ext
from distutils.command.build_py import build_py from distutils.command.build_py import build_py
from distutils.command.build_scripts import build_scripts from distutils.command.build_scripts import build_scripts
from distutils.command.install import install from distutils.command.install import install
from distutils.command.install_data import install_data
from distutils.command.install_lib import install_lib from distutils.command.install_lib import install_lib
from distutils.command.install_scripts import install_scripts from distutils.command.install_scripts import install_scripts
from distutils import log from distutils import log
from distutils.spawn import spawn, find_executable from distutils.spawn import spawn, find_executable
from distutils import file_util from distutils import file_util
from distutils.errors import ( from distutils.errors import (
CCompilerError, CCompilerError,
DistutilsError, DistutilsError,
DistutilsExecError, DistutilsExecError,
) )
from distutils.sysconfig import get_python_inc, get_config_var from distutils.sysconfig import get_python_inc, get_config_var
from distutils.version import StrictVersion from distutils.version import StrictVersion
# Explain to distutils.StrictVersion how our release candidates are versionned # Explain to distutils.StrictVersion how our release candidates are versionned
StrictVersion.version_re = re.compile(r'^(\d+)\.(\d+)(\.(\d+))?-?(rc(\d+))?$') StrictVersion.version_re = re.compile(r'^(\d+)\.(\d+)(\.(\d+))?-?(rc(\d+))?$')
# Can we build the documentation?
try:
import docutils
except ImportError:
docutils = None
def write_if_changed(path, content): def write_if_changed(path, content):
"""Write content to a file iff the content hasn't changed.""" """Write content to a file iff the content hasn't changed."""
if os.path.exists(path): if os.path.exists(path):
with open(path, 'rb') as fh: with open(path, 'rb') as fh:
current = fh.read() current = fh.read()
else: else:
current = b'' current = b''
os.environ['HGMODULEPOLICY'] = oldpolicy os.environ['HGMODULEPOLICY'] = oldpolicy
class hgbuild(build): class hgbuild(build):
# Insert hgbuildmo first so that files in mercurial/locale/ are found # Insert hgbuildmo first so that files in mercurial/locale/ are found
# when build_py is run next. # when build_py is run next.
sub_commands = [('build_mo', None)] + build.sub_commands sub_commands = [('build_mo', None)] + build.sub_commands
def run(self):
if os.name == 'nt':
pass
elif docutils is None:
marmouteUnsubmitted
Not Done

small nits: you are checking for None so use is not None please.

marmoute: small nits: you are checking for None so use `is not None` please.
danchrAuthorUnsubmitted
Done

Done.

danchr: Done.
log.warn('not building optional documentation')
else:
self.run_command('build_doc')
class hgbuildmo(build): class hgbuildmo(build):
description = "build translations (.mo files)" description = "build translations (.mo files)"
def run(self): def run(self):
if not find_executable('msgfmt'): if not find_executable('msgfmt'):
self.warn( self.warn(
gengendoc(root) gengendoc(root)
if self.man: if self.man:
genman(root) genman(root)
if self.html: if self.html:
genhtml(root) genhtml(root)
class hginstalldata(install_data):
user_options = install_data.user_options + [
(
'install-man=',
None,
'installation directory for manual pages [share/man]',
),
]
install_man = None
def finalize_options(self):
install_data.finalize_options(self)
self.set_undefined_options('install', ('install_man', 'install_man'))
if self.install_man is None:
self.install_man = os.path.join('share', 'man')
if os.name == 'nt':
pass
elif docutils is None:
log.warn('not installing manual pages')
else:
manpages = [
f for f in os.listdir('doc') if re.search(r'\.[0-9]$', f)
]
self.data_files += [
(
os.path.join(self.install_man, 'man' + ext[1:]),
['doc/' + f for f in manpages if f.endswith(ext)],
)
for ext in set(os.path.splitext(f)[1] for f in manpages)
]
class hginstall(install): class hginstall(install):
user_options = install.user_options + [ user_options = install.user_options + [
( (
'old-and-unmanageable', 'old-and-unmanageable',
None, None,
'noop, present for eggless setuptools compat', 'noop, present for eggless setuptools compat',
), ),
( (
'single-version-externally-managed', 'single-version-externally-managed',
None, None,
'noop, present for eggless setuptools compat', 'noop, present for eggless setuptools compat',
), ),
(
'install-man=',
None,
'installation directory for manual pages [share/man]',
),
] ]
# Also helps setuptools not be sad while we refuse to create eggs. # Also helps setuptools not be sad while we refuse to create eggs.
single_version_externally_managed = True single_version_externally_managed = True
install_man = None
def get_sub_commands(self): def get_sub_commands(self):
subcommands = install.get_sub_commands(self)
subcommands.append('install_data')
# Screen out egg related commands to prevent egg generation. But allow # Screen out egg related commands to prevent egg generation. But allow
# mercurial.egg-info generation, since that is part of modern # mercurial.egg-info generation, since that is part of modern
# packaging. # packaging.
excl = {'bdist_egg'} excl = {'bdist_egg'}
return filter(lambda x: x not in excl, install.get_sub_commands(self)) return filter(lambda x: x not in excl, subcommands)
class hginstalllib(install_lib): class hginstalllib(install_lib):
""" """
This is a specialization of install_lib that replaces the copy_file used This is a specialization of install_lib that replaces the copy_file used
there so that it supports setting the mode of files after copying them, there so that it supports setting the mode of files after copying them,
instead of just preserving the mode that the files originally had. If your instead of just preserving the mode that the files originally had. If your
system has a umask of something like 027, preserving the permissions when system has a umask of something like 027, preserving the permissions when
'build_doc': hgbuilddoc, 'build_doc': hgbuilddoc,
'build_mo': hgbuildmo, 'build_mo': hgbuildmo,
'build_ext': hgbuildext, 'build_ext': hgbuildext,
'build_py': hgbuildpy, 'build_py': hgbuildpy,
'build_scripts': hgbuildscripts, 'build_scripts': hgbuildscripts,
'build_hgextindex': buildhgextindex, 'build_hgextindex': buildhgextindex,
'install': hginstall, 'install': hginstall,
'install_lib': hginstalllib, 'install_lib': hginstalllib,
'install_data': hginstalldata,
'install_scripts': hginstallscripts, 'install_scripts': hginstallscripts,
'build_hgexe': buildhgexe, 'build_hgexe': buildhgexe,
} }
if py2exehacked: if py2exehacked:
cmdclass['py2exe'] = hgbuildpy2exe cmdclass['py2exe'] = hgbuildpy2exe
packages = [ packages = [