This is an archive of the discontinued Mercurial Phabricator instance.

Differential D587

copytrace: add `hg help copytrace`
AbandonedPublic

Authored by durin42 on Aug 31 2017, 6:29 PM.

Download Raw Diff

Details

Reviewers

pulkit

Group Reviewers

hg-reviewers

Summary

Currently we have one slow implementation of copytrace. While moving
fbext/copytrace to core, a lot of things will be introduced and some new
configs for user to switch between different implementations. But if that goes
undocumented the configs will be magic for the user. So lets document copytrace
first before we add any new logic or config options.

Diff Detail

Repository

rHG Mercurial

Lint

Lint Skipped

Unit

Unit Tests Skipped

Event Timeline

pulkit created this revision.Aug 31 2017, 6:29 PM

Herald added a reviewer: hg-reviewers. · View Herald TranscriptAug 31 2017, 6:29 PM

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

diff --git a/tests/test-install.t b/tests/test-install.t
 --- a/tests/test-install.t
 +++ b/tests/test-install.t
 @@ -162,6 +162,7 @@
   $ ( testrepohgenv; $PYTHON wixxml.py help )
   Not installed:
     help/common.txt
+    help/copytrace.txt
     help/hg-ssh.8.txt
     help/hg.1.txt
     help/hgignore.5.txt

Instead of this, can you update 'contrib/wix/help.wxs' to keep the Windows installer happy? See 876f08f30ade.

pulkit updated this revision to Diff 1583.Sep 2 2017, 2:15 PM

My understanding with copytracing was wrong and also it's not a great doc. I will try to work on this later, maybe taking someone's help in the sprint.

Let's reopen this if/when we return to it.

Revision Contents
Changeset List

		Path
M		contrib/wix/help.wxs (1 line)
M		mercurial/help.py (1 line)
A	M	mercurial/help/copytrace.txt (33 lines)
M		tests/test-globalopts.t (2 lines)
M		tests/test-help.t (10 lines)
M		tests/test-hgweb-json.t (4 lines)

Diff 1583

contrib/wix/help.wxs


	<Fragment>			<Fragment>
	<DirectoryRef Id="INSTALLDIR">			<DirectoryRef Id="INSTALLDIR">
	<Directory Id="helpdir" Name="help" FileSource="$(var.SourceDir)">			<Directory Id="helpdir" Name="help" FileSource="$(var.SourceDir)">
	<Component Id="help.root" Guid="$(var.help.root.guid)" Win64='$(var.IsX64)'>			<Component Id="help.root" Guid="$(var.help.root.guid)" Win64='$(var.IsX64)'>
	<File Name="bundlespec.txt" />			<File Name="bundlespec.txt" />
	<File Name="color.txt" />			<File Name="color.txt" />
	<File Name="config.txt" KeyPath="yes" />			<File Name="config.txt" KeyPath="yes" />
				<File Name="copytrace.txt" />
	<File Name="dates.txt" />			<File Name="dates.txt" />
	<File Name="diffs.txt" />			<File Name="diffs.txt" />
	<File Name="environment.txt" />			<File Name="environment.txt" />
	<File Name="extensions.txt" />			<File Name="extensions.txt" />
	<File Name="filesets.txt" />			<File Name="filesets.txt" />
	<File Name="glossary.txt" />			<File Name="glossary.txt" />
	<File Name="hgignore.txt" />			<File Name="hgignore.txt" />
	<File Name="hgweb.txt" />			<File Name="hgweb.txt" />

mercurial/help.py

	lines = ['To access a subtopic, use "hg help internals.{subtopic-name}"\n',			lines = ['To access a subtopic, use "hg help internals.{subtopic-name}"\n',
	'\n']			'\n']
	for names, header, doc in internalstable:			for names, header, doc in internalstable:
	lines.append(' :%s: %s\n' % (names[0], header))			lines.append(' :%s: %s\n' % (names[0], header))

	return ''.join(lines)			return ''.join(lines)

	helptable = sorted([			helptable = sorted([
				(['copytrace'], _("Copytracing in Mercurial"), loaddoc('copytrace')),
	(['bundlespec'], _("Bundle File Formats"), loaddoc('bundlespec')),			(['bundlespec'], _("Bundle File Formats"), loaddoc('bundlespec')),
	(['color'], _("Colorizing Outputs"), loaddoc('color')),			(['color'], _("Colorizing Outputs"), loaddoc('color')),
	(["config", "hgrc"], _("Configuration Files"), loaddoc('config')),			(["config", "hgrc"], _("Configuration Files"), loaddoc('config')),
	(["dates"], _("Date Formats"), loaddoc('dates')),			(["dates"], _("Date Formats"), loaddoc('dates')),
	(["patterns"], _("File Name Patterns"), loaddoc('patterns')),			(["patterns"], _("File Name Patterns"), loaddoc('patterns')),
	(['environment', 'env'], _('Environment Variables'),			(['environment', 'env'], _('Environment Variables'),
	loaddoc('environment')),			loaddoc('environment')),
	(['revisions', 'revs', 'revsets', 'revset', 'multirevs', 'mrevs'],			(['revisions', 'revs', 'revsets', 'revset', 'multirevs', 'mrevs'],

mercurial/help/copytrace.txt

This file was added.

				Mercurial does not stores information about copies or moves if you don't use
				`hg move` or `hg copy`.

				Copytracing is tracing copies or moves which user did when performing commands
				like rebase, merge, unshelve etc. to merge files that were move/copied in one
				merge parent and modified in another. Let's take a quick example::

				o 3 Current head
				\|
				.
				. o 4 More modifications to a.txt
				\| /
				o / 2 Renamed a.txt to b.txt
				\|/
				o 1 Modified a.txt
				\|
				o 0 Added a.txt

				Let's say that now we want to rebase revision '4' with description "more
				modifictaions to a.txt" on revision '3' with description "current head".
				Mercurial tries that but wait, there is no 'a.txt' in the "current head" and it
				will show you the following annoying message:

				```
				other [source] changed a which local [dest] deleted
				use (c)hanged version, leave (d)eleted, or leave (u)nresolved?
				```

				Copytracing is disabled by default as the default copytracing method is slow.
				You can turn that on by setting the following::

				[experimental]
				disablecopytrace = False

tests/test-globalopts.t

	verify verify the integrity of the repository			verify verify the integrity of the repository
	version output version and copyright information			version output version and copyright information

	additional help topics:			additional help topics:

	bundlespec Bundle File Formats			bundlespec Bundle File Formats
	color Colorizing Outputs			color Colorizing Outputs
	config Configuration Files			config Configuration Files
				copytrace Copytracing in Mercurial
	dates Date Formats			dates Date Formats
	diffs Diff Formats			diffs Diff Formats
	environment Environment Variables			environment Environment Variables
	extensions Using Additional Features			extensions Using Additional Features
	filesets Specifying File Sets			filesets Specifying File Sets
	glossary Glossary			glossary Glossary
	hgignore Syntax for Mercurial Ignore Files			hgignore Syntax for Mercurial Ignore Files
	hgweb Configuring hgweb			hgweb Configuring hgweb
	verify verify the integrity of the repository			verify verify the integrity of the repository
	version output version and copyright information			version output version and copyright information

	additional help topics:			additional help topics:

	bundlespec Bundle File Formats			bundlespec Bundle File Formats
	color Colorizing Outputs			color Colorizing Outputs
	config Configuration Files			config Configuration Files
				copytrace Copytracing in Mercurial
	dates Date Formats			dates Date Formats
	diffs Diff Formats			diffs Diff Formats
	environment Environment Variables			environment Environment Variables
	extensions Using Additional Features			extensions Using Additional Features
	filesets Specifying File Sets			filesets Specifying File Sets
	glossary Glossary			glossary Glossary
	hgignore Syntax for Mercurial Ignore Files			hgignore Syntax for Mercurial Ignore Files
	hgweb Configuring hgweb			hgweb Configuring hgweb

tests/test-help.t

	verify verify the integrity of the repository			verify verify the integrity of the repository
	version output version and copyright information			version output version and copyright information

	additional help topics:			additional help topics:

	bundlespec Bundle File Formats			bundlespec Bundle File Formats
	color Colorizing Outputs			color Colorizing Outputs
	config Configuration Files			config Configuration Files
				copytrace Copytracing in Mercurial
	dates Date Formats			dates Date Formats
	diffs Diff Formats			diffs Diff Formats
	environment Environment Variables			environment Environment Variables
	extensions Using Additional Features			extensions Using Additional Features
	filesets Specifying File Sets			filesets Specifying File Sets
	glossary Glossary			glossary Glossary
	hgignore Syntax for Mercurial Ignore Files			hgignore Syntax for Mercurial Ignore Files
	hgweb Configuring hgweb			hgweb Configuring hgweb
	verify verify the integrity of the repository			verify verify the integrity of the repository
	version output version and copyright information			version output version and copyright information

	additional help topics:			additional help topics:

	bundlespec Bundle File Formats			bundlespec Bundle File Formats
	color Colorizing Outputs			color Colorizing Outputs
	config Configuration Files			config Configuration Files
				copytrace Copytracing in Mercurial
	dates Date Formats			dates Date Formats
	diffs Diff Formats			diffs Diff Formats
	environment Environment Variables			environment Environment Variables
	extensions Using Additional Features			extensions Using Additional Features
	filesets Specifying File Sets			filesets Specifying File Sets
	glossary Glossary			glossary Glossary
	hgignore Syntax for Mercurial Ignore Files			hgignore Syntax for Mercurial Ignore Files
	hgweb Configuring hgweb			hgweb Configuring hgweb

	helpext (no help text available)			helpext (no help text available)

	additional help topics:			additional help topics:

	bundlespec Bundle File Formats			bundlespec Bundle File Formats
	color Colorizing Outputs			color Colorizing Outputs
	config Configuration Files			config Configuration Files
				copytrace Copytracing in Mercurial
	dates Date Formats			dates Date Formats
	diffs Diff Formats			diffs Diff Formats
	environment Environment Variables			environment Environment Variables
	extensions Using Additional Features			extensions Using Additional Features
	filesets Specifying File Sets			filesets Specifying File Sets
	glossary Glossary			glossary Glossary
	hgignore Syntax for Mercurial Ignore Files			hgignore Syntax for Mercurial Ignore Files
	hgweb Configuring hgweb			hgweb Configuring hgweb
	<tr><td>			<tr><td>
	<a href="/help/config">			<a href="/help/config">
	config			config
	</a>			</a>
	</td><td>			</td><td>
	Configuration Files			Configuration Files
	</td></tr>			</td></tr>
	<tr><td>			<tr><td>
				<a href="/help/copytrace">
				copytrace
				</a>
				</td><td>
				Copytracing in Mercurial
				</td></tr>
				<tr><td>
	<a href="/help/dates">			<a href="/help/dates">
	dates			dates
	</a>			</a>
	</td><td>			</td><td>
	Date Formats			Date Formats
	</td></tr>			</td></tr>
	<tr><td>			<tr><td>
	<a href="/help/diffs">			<a href="/help/diffs">

tests/test-hgweb-json.t

	"summary": "Colorizing Outputs",			"summary": "Colorizing Outputs",
	"topic": "color"			"topic": "color"
	},			},
	{			{
	"summary": "Configuration Files",			"summary": "Configuration Files",
	"topic": "config"			"topic": "config"
	},			},
	{			{
				"summary": "Copytracing in Mercurial",
				"topic": "copytrace"
				},
				{
	"summary": "Date Formats",			"summary": "Date Formats",
	"topic": "dates"			"topic": "dates"
	},			},
	{			{
	"summary": "Diff Formats",			"summary": "Diff Formats",
	"topic": "diffs"			"topic": "diffs"
	},			},
	{			{

Diff	ID	Description	Created	Lint	Unit
Base		Base
Diff 1	1519		Aug 31 2017, 6:29 PM	★	★
Diff 2	1583		Sep 2 2017, 2:15 PM	★	★