This is an archive of the discontinued Mercurial Phabricator instance.

Differential D6877

merge: replace magic strings with NAMED_CONSTANTS (API)
ClosedPublic

Authored by durin42 on Sep 25 2019, 11:10 AM.

Download Raw Diff

Details

Reviewers

pulkit

Group Reviewers

hg-reviewers

Commits

rHG1ad3ebb39c61: merge: replace magic strings with NAMED_CONSTANTS (API)

Summary

.. api::

`mercurial.hg.update*` and `mercurial.merge.update` now expect a value
from a set of NAMED_CONSTANTS (`merge.UPDATECHECK_*` constants)
rather than a collection of magic strings. As of now, the values
are the same, but code should be prepared for these values to
change in the future.

Diff Detail

Repository

rHG Mercurial

Lint

Lint Skipped

Unit

Unit Tests Skipped

Event Timeline

durin42 created this revision.Sep 25 2019, 11:10 AM

Herald added a reviewer: hg-reviewers. · View Herald TranscriptSep 25 2019, 11:10 AM

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

durin42 added a child revision: D6878: hg: have `updatetotally` more thoroughly check updatecheck argument (API).Sep 25 2019, 11:10 AM

pulkit accepted this revision.Sep 25 2019, 11:33 AM

This revision is now accepted and ready to land.Sep 25 2019, 11:33 AM

durin42 added a commit: rHG1ad3ebb39c61: merge: replace magic strings with NAMED_CONSTANTS (API).Sep 25 2019, 11:56 AM

Closed by commit rHG1ad3ebb39c61: merge: replace magic strings with NAMED_CONSTANTS (API) (authored by durin42). · Explain Why

This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

			Path	Packages
M			mercurial/hg.py (23 lines)
M			mercurial/merge.py (16 lines)

Commit	Parents	Author	Summary	Date
86c175813194	cc4613e14d2c	Augie Fackler		Sep 25 2019, 10:53 AM

Status	Author	Revision
Closed	durin42	D6879 merge: check argument value with if/raise instead of an assert
Closed	durin42	D6878 hg: have `updatetotally` more thoroughly check updatecheck argument (API)
Closed	durin42	D6877 merge: replace magic strings with NAMED_CONSTANTS (API)

Diff 16605

mercurial/hg.py


	This takes arguments below:			This takes arguments below:

	:checkout: to which revision the working directory is updated			:checkout: to which revision the working directory is updated
	:brev: a name, which might be a bookmark to be activated after updating			:brev: a name, which might be a bookmark to be activated after updating
	:clean: whether changes in the working directory can be discarded			:clean: whether changes in the working directory can be discarded
	:updatecheck: how to deal with a dirty working directory			:updatecheck: how to deal with a dirty working directory

	Valid values for updatecheck are (None => linear):			Valid values for updatecheck are the UPDATECHECK_* constants
				defined in the merge module. Passing `None` will result in using the
	* abort: abort if the working directory is dirty			configured default.
	* none: don't check (merge working directory changes into destination)
	* linear: check that update is linear before merging working directory			* ABORT: abort if the working directory is dirty
				* NONE: don't check (merge working directory changes into destination)
				* LINEAR: check that update is linear before merging working directory
	changes into destination			changes into destination
	* noconflict: check that the update does not result in file merges			* NO_CONFLICT: check that the update does not result in file merges

	This returns whether conflict is detected at updating or not.			This returns whether conflict is detected at updating or not.
	"""			"""
	if updatecheck is None:			if updatecheck is None:
	updatecheck = ui.config('commands', 'update.check')			updatecheck = ui.config('commands', 'update.check')
	if updatecheck not in ('abort', 'none', 'linear', 'noconflict'):			if updatecheck not in (mergemod.UPDATECHECK_ABORT,
				mergemod.UPDATECHECK_NONE,
				mergemod.UPDATECHECK_LINEAR,
				mergemod.UPDATECHECK_NO_CONFLICT):
	# If not configured, or invalid value configured			# If not configured, or invalid value configured
	updatecheck = 'linear'			updatecheck = mergemod.UPDATECHECK_LINEAR
	with repo.wlock():			with repo.wlock():
	movemarkfrom = None			movemarkfrom = None
	warndest = False			warndest = False
	if checkout is None:			if checkout is None:
	updata = destutil.destupdate(repo, clean=clean)			updata = destutil.destupdate(repo, clean=clean)
	checkout, movemarkfrom, brev = updata			checkout, movemarkfrom, brev = updata
	warndest = True			warndest = True

	if clean:			if clean:
	ret = _clean(repo, checkout)			ret = _clean(repo, checkout)
	else:			else:
	if updatecheck == 'abort':			if updatecheck == mergemod.UPDATECHECK_ABORT:
	cmdutil.bailifchanged(repo, merge=False)			cmdutil.bailifchanged(repo, merge=False)
	updatecheck = 'none'			updatecheck = mergemod.UPDATECHECK_NONE
	ret = _update(repo, checkout, updatecheck=updatecheck)			ret = _update(repo, checkout, updatecheck=updatecheck)

	if not ret and movemarkfrom:			if not ret and movemarkfrom:
	if movemarkfrom == repo['.'].node():			if movemarkfrom == repo['.'].node():
	pass # no-op update			pass # no-op update
	elif bookmarks.update(repo, [movemarkfrom], repo['.'].node()):			elif bookmarks.update(repo, [movemarkfrom], repo['.'].node()):
	b = ui.label(repo._activebookmark, 'bookmarks.active')			b = ui.label(repo._activebookmark, 'bookmarks.active')
	ui.status(_("updating bookmark %s\n") % b)			ui.status(_("updating bookmark %s\n") % b)

mercurial/merge.py

	for f, args, msg in actions.get(ACTION_LOCAL_DIR_RENAME_GET, []):			for f, args, msg in actions.get(ACTION_LOCAL_DIR_RENAME_GET, []):
	f0, flag = args			f0, flag = args
	if branchmerge:			if branchmerge:
	repo.dirstate.add(f)			repo.dirstate.add(f)
	repo.dirstate.copy(f0, f)			repo.dirstate.copy(f0, f)
	else:			else:
	repo.dirstate.normal(f)			repo.dirstate.normal(f)

				UPDATECHECK_ABORT = 'abort' # handled at higher layers
				UPDATECHECK_NONE = 'none'
				UPDATECHECK_LINEAR = 'linear'
				UPDATECHECK_NO_CONFLICT = 'noconflict'

	def update(repo, node, branchmerge, force, ancestor=None,			def update(repo, node, branchmerge, force, ancestor=None,
	mergeancestor=False, labels=None, matcher=None, mergeforce=False,			mergeancestor=False, labels=None, matcher=None, mergeforce=False,
	updatecheck=None, wc=None):			updatecheck=None, wc=None):
	"""			"""
	Perform a merge between the working directory and the given node			Perform a merge between the working directory and the given node

	node = the node to update to			node = the node to update to
	branchmerge = whether to merge between branches			branchmerge = whether to merge between branches
	# This function used to find the default destination if node was None, but			# This function used to find the default destination if node was None, but
	# that's now in destutil.py.			# that's now in destutil.py.
	assert node is not None			assert node is not None
	if not branchmerge and not force:			if not branchmerge and not force:
	# TODO: remove the default once all callers that pass branchmerge=False			# TODO: remove the default once all callers that pass branchmerge=False
	# and force=False pass a value for updatecheck. We may want to allow			# and force=False pass a value for updatecheck. We may want to allow
	# updatecheck='abort' to better suppport some of these callers.			# updatecheck='abort' to better suppport some of these callers.
	if updatecheck is None:			if updatecheck is None:
	updatecheck = 'linear'			updatecheck = UPDATECHECK_LINEAR
	assert updatecheck in ('none', 'linear', 'noconflict')			assert updatecheck in (UPDATECHECK_NONE,
				UPDATECHECK_LINEAR,
				UPDATECHECK_NO_CONFLICT,
				)
	# If we're doing a partial update, we need to skip updating			# If we're doing a partial update, we need to skip updating
	# the dirstate, so make a note of any partial-ness to the			# the dirstate, so make a note of any partial-ness to the
	# update here.			# update here.
	if matcher is None or matcher.always():			if matcher is None or matcher.always():
	partial = False			partial = False
	else:			else:
	partial = True			partial = True
	with repo.wlock():			with repo.wlock():

	elif not overwrite:			elif not overwrite:
	if p1 == p2: # no-op update			if p1 == p2: # no-op update
	# call the hooks and exit early			# call the hooks and exit early
	repo.hook('preupdate', throw=True, parent1=xp2, parent2='')			repo.hook('preupdate', throw=True, parent1=xp2, parent2='')
	repo.hook('update', parent1=xp2, parent2='', error=0)			repo.hook('update', parent1=xp2, parent2='', error=0)
	return updateresult(0, 0, 0, 0)			return updateresult(0, 0, 0, 0)

	if (updatecheck == 'linear' and			if (updatecheck == UPDATECHECK_LINEAR and
	pas not in ([p1], [p2])): # nonlinear			pas not in ([p1], [p2])): # nonlinear
	dirty = wc.dirty(missing=True)			dirty = wc.dirty(missing=True)
	if dirty:			if dirty:
	# Branching is a bit strange to ensure we do the minimal			# Branching is a bit strange to ensure we do the minimal
	# amount of call to obsutil.foreground.			# amount of call to obsutil.foreground.
	foreground = obsutil.foreground(repo, [p1.node()])			foreground = obsutil.foreground(repo, [p1.node()])
	# note: the <node> variable contains a random identifier			# note: the <node> variable contains a random identifier
	if repo[node].node() in foreground:			if repo[node].node() in foreground:
	if not branchmerge and not wc.dirty(missing=True):			if not branchmerge and not wc.dirty(missing=True):
	followcopies = False			followcopies = False

	### calculate phase			### calculate phase
	actionbyfile, diverge, renamedelete = calculateupdates(			actionbyfile, diverge, renamedelete = calculateupdates(
	repo, wc, p2, pas, branchmerge, force, mergeancestor,			repo, wc, p2, pas, branchmerge, force, mergeancestor,
	followcopies, matcher=matcher, mergeforce=mergeforce)			followcopies, matcher=matcher, mergeforce=mergeforce)

	if updatecheck == 'noconflict':			if updatecheck == UPDATECHECK_NO_CONFLICT:
	for f, (m, args, msg) in actionbyfile.iteritems():			for f, (m, args, msg) in actionbyfile.iteritems():
	if m not in (ACTION_GET, ACTION_KEEP, ACTION_EXEC,			if m not in (ACTION_GET, ACTION_KEEP, ACTION_EXEC,
	ACTION_REMOVE, ACTION_PATH_CONFLICT_RESOLVE):			ACTION_REMOVE, ACTION_PATH_CONFLICT_RESOLVE):
	msg = _("conflicting changes")			msg = _("conflicting changes")
	hint = _("commit or update --clean to discard changes")			hint = _("commit or update --clean to discard changes")
	raise error.Abort(msg, hint=hint)			raise error.Abort(msg, hint=hint)

	# Prompt and create actions. Most of this is in the resolve phase			# Prompt and create actions. Most of this is in the resolve phase

Diff	ID	Description	Created	Lint	Unit
Base		Base
Diff 1	16605		Sep 25 2019, 11:10 AM	★	★
Diff 2	16610	rHG1ad3ebb39c6146cb33d50bf0c8c50bc2ec78e464	Sep 25 2019, 10:53 AM	★	★