This is an archive of the discontinued Mercurial Phabricator instance.

Differential D175

sparse: add a config option to decide if paths are reporoot-relative
ClosedPublic

Authored by ikostia on Jul 21 2017, 2:31 PM.

Download Raw Diff

Details

Reviewers

mjpieters

Group Reviewers

Restricted Project

Commits

rFBHGX1cce1fd5d87b: sparse: add a config option to decide if paths are reporoot-relative

Summary

This adds two separate config knobs, one for include/exclude, one for enable/disable-profile. The reason for two separate options is that one is used much more frequently than the other, so migrating existing users for two usecases is a very different effort.

The config options have different defaults: it's cwd-relative for include/exclude and repo-root-relative for enable-disable.

Test Plan

Diff Detail

Repository

rFBHGX Facebook Mercurial Extensions

Branch

default

Lint

Lint OK

Unit

Unit Tests OK

Event Timeline

ikostia created this revision.Jul 21 2017, 2:31 PM

Herald added a reviewer: Restricted Project. · View Herald TranscriptJul 21 2017, 2:31 PM

ikostia added a parent revision: D174: sparse: properly error out when absolute paths are used.Jul 21 2017, 2:31 PM

With the current default, paths-always-relative-to-hgroot, the command-line UI is confusing for users, whom expect to be able to auto-complete paths from their current working dir instead. I know it is a breaking change, but I'd rather see the option be disabled by default instead.

ikostia planned changes to this revision.Jul 24 2017, 6:28 AM

add another config option

ikostia edited the summary of this revision. (Show Details)Jul 24 2017, 7:23 AM

ikostia edited the summary of this revision. (Show Details)

mjpieters accepted this revision.Jul 25 2017, 11:13 AM

mjpieters added inline comments.

hgext3rd/sparse.py
766–767	Please use parentheses and not a backslash to continue lines: if (not ui.configbool('sparse', 'includereporootpaths', False) and (include or exclude)):
772–773	ditto

This revision is now accepted and ready to land.Jul 25 2017, 11:13 AM

Closed by commit rFBHGX1cce1fd5d87b: sparse: add a config option to decide if paths are reporoot-relative (authored by ikostia). · Explain WhyJul 25 2017, 1:45 PM

This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

			Path	Packages
M			hgext3rd/sparse.py (47 lines)
M			tests/test-sparse.t (17 lines)

Diff	ID	Description	Created	Lint	Unit
Base		Base
Diff 1	382		Jul 21 2017, 2:30 PM	★	★
Diff 2	388	add another config option	Jul 24 2017, 7:18 AM	★	★
Diff 3	403	rFBHGX1cce1fd5d87bd930bc15fec5c531068179615602	Jul 25 2017, 1:43 PM	★	★

Commit	Local	Parents	Author	Summary	Date
2ca85a81ca75	3587	6197659d1528	Kostia Balytskyi	sparse: add a config option to decide if paths are reporoot-relative (Show More…)	Jul 24 2017, 7:14 AM

	Status	Author	Revision
	Closed	ikostia	D175 sparse: add a config option to decide if paths are reporoot-relative
	Closed	ikostia	D174 sparse: properly error out when absolute paths are used

Diff 388

hgext3rd/sparse.py

	# sparse.py - allow sparse checkouts of the working directory			# sparse.py - allow sparse checkouts of the working directory
	#			#
	# Copyright 2014 Facebook, Inc.			# Copyright 2014 Facebook, Inc.
	#			#
	# This software may be used and distributed according to the terms of the			# This software may be used and distributed according to the terms of the
	# GNU General Public License version 2 or any later version.			# GNU General Public License version 2 or any later version.

	"""allow sparse checkouts of the working directory			"""allow sparse checkouts of the working directory
	"""			"""

	from mercurial import util, cmdutil, extensions, context, dirstate, commands			from mercurial import util, cmdutil, extensions, context, dirstate, commands
	from mercurial import localrepo, error, hg, registrar			from mercurial import localrepo, error, hg, registrar, scmutil
	from mercurial import match as matchmod			from mercurial import match as matchmod
	from mercurial import merge as mergemod			from mercurial import merge as mergemod
	from mercurial.node import nullid			from mercurial.node import nullid
	from mercurial.i18n import _			from mercurial.i18n import _
	import os, collections, hashlib			import os, collections, hashlib

	cmdtable = {}			cmdtable = {}
	command = registrar.command(cmdtable)			command = registrar.command(cmdtable)
	exclude = True			exclude = True
	if enableprofile_pat:			if enableprofile_pat:
	pat = enableprofile_pat			pat = enableprofile_pat
	enableprofile = True			enableprofile = True
	if sum([include, exclude, enableprofile]) > 1:			if sum([include, exclude, enableprofile]) > 1:
	raise error.Abort(_("too many flags specified."))			raise error.Abort(_("too many flags specified."))
	if include or exclude or enableprofile:			if include or exclude or enableprofile:
	def clone_sparse(orig, self, node, overwrite, args, *kwargs):			def clone_sparse(orig, self, node, overwrite, args, *kwargs):
				# sparse clone is a special snowflake as in that case always
				# are outside of the repo's dir hierachy, yet we always want
				# to name our includes/excludes/enables using repo-root
				# relative paths
				overrides = {
				('sparse', 'includereporootpaths'): True,
				('sparse', 'enablereporootpaths'): True,
				}
				with self.ui.configoverride(overrides, 'sparse'):
	_config(self.ui, self.unfiltered(), pat, {}, include=include,			_config(self.ui, self.unfiltered(), pat, {}, include=include,
	exclude=exclude, enableprofile=enableprofile)			exclude=exclude, enableprofile=enableprofile)
	return orig(self, node, overwrite, args, *kwargs)			return orig(self, node, overwrite, args, *kwargs)
	extensions.wrapfunction(hg, 'updaterepo', clone_sparse)			extensions.wrapfunction(hg, 'updaterepo', clone_sparse)
	return orig(ui, repo, args, *opts)			return orig(ui, repo, args, *opts)

	def _setupclone(ui):			def _setupclone(ui):
	entry = commands.table['^clone']			entry = commands.table['^clone']
	entry[1].append(('', 'enable-profile', [],			entry[1].append(('', 'enable-profile', [],
	'enable a sparse profile'))			'enable a sparse profile'))
	--import-rules accepts a path to a file containing rules in the .hgsparse			--import-rules accepts a path to a file containing rules in the .hgsparse
	format, allowing you to add --include, --exclude and --enable-profile rules			format, allowing you to add --include, --exclude and --enable-profile rules
	in bulk. Like the --include, --exclude and --enable-profile switches, the			in bulk. Like the --include, --exclude and --enable-profile switches, the
	changes are applied immediately.			changes are applied immediately.

	--clear-rules removes all local include and exclude rules, while leaving			--clear-rules removes all local include and exclude rules, while leaving
	any enabled profiles in place.			any enabled profiles in place.

				The following config option defines whether sparse treats supplied
				paths as relative to repo root or to the current working dir for
				include and exclude options:

				[sparse]
				includereporootpaths = off

				The following config option defines whether sparse treats supplied
				paths as relative to repo root or to the current working dir for
				enableprofile and disableprofile options:

				[sparse]
				enablereporootpaths = on

	Returns 0 if editing the sparse checkout succeeds.			Returns 0 if editing the sparse checkout succeeds.
	"""			"""
	include = opts.get('include')			include = opts.get('include')
	exclude = opts.get('exclude')			exclude = opts.get('exclude')
	force = opts.get('force')			force = opts.get('force')
	enableprofile = opts.get('enable_profile')			enableprofile = opts.get('enable_profile')
	disableprofile = opts.get('disable_profile')			disableprofile = opts.get('disable_profile')
	importrules = opts.get('import_rules')			importrules = opts.get('import_rules')
	newinclude = set()			newinclude = set()
	newexclude = set()			newexclude = set()
	newprofiles = set()			newprofiles = set()
	else:			else:
	newinclude = set(oldinclude)			newinclude = set(oldinclude)
	newexclude = set(oldexclude)			newexclude = set(oldexclude)
	newprofiles = set(oldprofiles)			newprofiles = set(oldprofiles)

	oldstatus = repo.status()

	if any(pat.startswith('/') for pat in pats):			if any(pat.startswith('/') for pat in pats):
	err = _('paths cannot start with /')			err = _('paths cannot start with /')
	hint = _('do not use absolute paths')			hint = _('do not use absolute paths')
	raise error.Abort(err, hint=hint)			raise error.Abort(err, hint=hint)
	elif include:
				if not ui.configbool('sparse', 'includereporootpaths', False)\
				and (include or exclude):
				mjpietersUnsubmitted Not Done Please use parentheses and not a backslash to continue lines: if (not ui.configbool('sparse', 'includereporootpaths', False) and (include or exclude)): mjpieters: Please use parentheses and not a backslash to continue lines: if (not ui.
				# supplied file patterns should be treated as relative
				# to current working dir, so we need to convert them first
				pats = scmutil.match(repo['.'], pats).files()

				if not ui.configbool('sparse', 'enablereporootpaths', True)\
				and (enableprofile or disableprofile):
				mjpietersUnsubmitted Not Done ditto mjpieters: ditto
				# supplied file patterns should be treated as relative
				# to current working dir, so we need to convert them first
				pats = scmutil.match(repo['.'], pats).files()

				oldstatus = repo.status()
				if include:
	newinclude.update(pats)			newinclude.update(pats)
	elif exclude:			elif exclude:
	newexclude.update(pats)			newexclude.update(pats)
	elif enableprofile:			elif enableprofile:
	newprofiles.update(pats)			newprofiles.update(pats)
	elif disableprofile:			elif disableprofile:
	newprofiles.difference_update(pats)			newprofiles.difference_update(pats)
	elif delete:			elif delete:

tests/test-sparse.t

	[255]			[255]
	$ hg sparse --include '$TESTTMP/myrepo/hide'			$ hg sparse --include '$TESTTMP/myrepo/hide'

	$ hg sparse --include '/root'			$ hg sparse --include '/root'
	abort: paths cannot start with /			abort: paths cannot start with /
	(do not use absolute paths)			(do not use absolute paths)
	[255]			[255]

				Repo root-relaive vs. cwd-relative includes
				$ mkdir subdir
				$ cd subdir
				$ hg sparse --config sparse.includereporootpaths=on --include reporoot/path
				$ hg sparse --config sparse.includereporootpaths=off --include cwd/path
				$ hg sparse
				[include]
				$TESTTMP/myrepo/hide
				hide
				reporoot/path
				subdir/cwd/path
				[exclude]


				$ cd ..
				$ rm -rf subdir

	Verify commiting while sparse includes other files			Verify commiting while sparse includes other files

	$ echo z > hide			$ echo z > hide
	$ hg ci -Aqm 'edit hide'			$ hg ci -Aqm 'edit hide'
	$ ls			$ ls
	hide			hide
	$ hg manifest			$ hg manifest
	hide			hide