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.

Download Raw Diff

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

Branch

default

Lint

No Linters Available

Unit

No Unit Test Coverage

Event Timeline

danchr created this revision.Dec 21 2020, 11:11 AM

Herald added a reviewer: hg-reviewers. · View Herald TranscriptDec 21 2020, 11:11 AM

Herald added a subscriber: mercurial-patches. · View Herald Transcript

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

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.

This changeset break some tests:

https://foss.heptapod.net/octobus/mercurial-devel/-/pipelines/16362

https://foss.heptapod.net/octobus/mercurial-devel/-/jobs/151020

@danchr can you have a look ?

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

marmoute mentioned this in D9697: shelve: rewrite check for unknown shelf to delete.Jan 16 2021, 7:34 PM

marmoute added a reverting change: D9803: test-regression: backing out D9640 (63c923fd7fa8).Jan 16 2021, 8:48 PM

marmoute added a reverting change: rHG4ffc38c109f9: test-regression: backing out D9640 (63c923fd7fa8).Jan 16 2021, 9:31 PM

marmoute added a reverting change: rHG2ef575c62f10: test-regression: backing out D9640 (63c923fd7fa8).Jan 17 2021, 2:21 AM

Revision Contents
Changeset List

			Path	Packages
M			setup.py (64 lines)

Diff	ID	Description	Created	Lint	Unit
Base		Base
Diff 1	24457		Dec 21 2020, 11:11 AM	★	★
Diff 2	24698		Jan 9 2021, 10:27 PM	★	★
Diff 3	24712		Jan 12 2021, 7:07 AM	★	★
Diff 4	24802	rHG63c923fd7fa8fec32b8c000fd970576a785d07ec	Dec 21 2020, 9:50 AM	★	★

Commit	Parents	Author	Summary	Date
45ad3f8b0b94	e4f6dae01b3b	Dan Villiom Podlaski Christiansen		Dec 21 2020, 9:50 AM

Status	Author	Revision
Needs Revision	danchr	D9727 ci: report status to phabricator on failures
Accepted	danchr	D9726 ci: use parallel matrices
Needs Revision	danchr	D9725 ci: generate and report XML test results
Needs Revision	danchr	D9724 ci: build python wheels
Closed	danchr	D9723 ci: avoid a global before_script definition
Closed	danchr	D9722 setup: don't import distutils prior to checking FORCE_SETUPTOOLS
Closed	danchr	D9640 setup: when possible, build and bundle man pages

Diff 24698

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.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):
				super(hginstalldata, self).finalize_options()

				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 = super(hginstall, self).get_sub_commands()
				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 = [