This is an archive of the discontinued Mercurial Phabricator instance.

sangeet259 retitled this revision from updates the help text for hg clone -r (issue5654) on bugzilla to clone: updates the help text for hg clone -r (issue5654) [bugzilla] and hg clone -b.Feb 9 2018, 9:28 AM

sangeet259 updated this revision to Diff 5370.

sangeet259 updated this revision to Diff 5371.Feb 9 2018, 9:36 AM

As mentioned in the issue, there's already an explanation paragraph in help:

To pull only a subset of changesets, specify one or more revisions
identifiers with -r/--rev or branches with -b/--branch. The resulting
clone will contain only the specified changesets and their ancestors.

@dlax Yes, but the short summary didn't say what it does! It just says "include the specified changeset".

sangeet259 (Sangeet Kumar Mishra) wrote:

@dlax https://phab.mercurial-scm.org/p/dlax/ Yes, but the short
summary didn't say what it does! It just says "include the specified
changeset".

I agree it's not super-clear. Perhaps we could say "clone only specified
changeset" for -r (help for -b looks ok to me).

There was a longish discussion on IRC about this. The problem is that the flags by themselves do not document the interaction of -r and -b or multiple instances of either at all. The change was a compromise trying to address that.

In D2095#35494, @joerg.sonnenberger wrote:

There was a longish discussion on IRC about this. The problem is that the flags by themselves do not document the interaction of -r and -b or multiple instances of either at all. The change was a compromise trying to address that.

Yeah, I had a long discussion regarding this on IRC, this is finally what all agreed upon.

I can live with this as a strict improvement over what we've got. Anyone object or want to agree with me?

(I'm happy to fix the inevitable test changes in flight)

For future bug fixes: we don't append [bugzilla] at the end of commits which fixes bug, we only mention the issue number. We use bugzilla only for bugs/issues, so an issue number in the commit message refers to the issue on bugzilla.

Oh! Thanks for letting me know!
I will keep that in mind.

durin42 accepted this revision.Mar 2 2018, 5:27 PM

This revision is now accepted and ready to land.Mar 2 2018, 5:27 PM

Closed by commit rHG4de15c54e59f: clone: updates the help text for hg clone -{r,b} (issue5654) (authored by sangeet259). · Explain WhyMar 2 2018, 6:48 PM

This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

			Path	Packages
M			mercurial/commands.py (6 lines)

Diff	ID	Description	Created	Lint	Unit
Base		Base
Diff 1	5356		Feb 8 2018, 1:05 PM	★	★
Diff 2	5370		Feb 9 2018, 9:28 AM	★	★
Diff 3	5371		Feb 9 2018, 9:36 AM	★	★
Diff 4	6401	rHG4de15c54e59fae5283e5516334f5687a7398f3aa	Feb 8 2018, 12:57 PM	★	★

Diff 5371

mercurial/commands.py

	return cmdutil.cat(ui, repo, ctx, m, fm, fntemplate, '',			return cmdutil.cat(ui, repo, ctx, m, fm, fntemplate, '',
	**pycompat.strkwargs(opts))			**pycompat.strkwargs(opts))

	@command('^clone',			@command('^clone',
	[('U', 'noupdate', None, _('the clone will include an empty working '			[('U', 'noupdate', None, _('the clone will include an empty working '
	'directory (only a repository)')),			'directory (only a repository)')),
	('u', 'updaterev', '', _('revision, tag, or branch to check out'),			('u', 'updaterev', '', _('revision, tag, or branch to check out'),
	_('REV')),			_('REV')),
	('r', 'rev', [], _('include the specified changeset'), _('REV')),			('r', 'rev', [], _('do not clone everything, but include this changeset\
	('b', 'branch', [], _('clone only the specified branch'), _('BRANCH')),			and its ancestors'), _('REV')),
				('b', 'branch', [], _('do not clone everything, but include this branch\'s\
				changesets and their ancestors'), _('BRANCH')),
	('', 'pull', None, _('use pull protocol to copy metadata')),			('', 'pull', None, _('use pull protocol to copy metadata')),
	('', 'uncompressed', None,			('', 'uncompressed', None,
	_('an alias to --stream (DEPRECATED)')),			_('an alias to --stream (DEPRECATED)')),
	('', 'stream', None,			('', 'stream', None,
	_('clone with minimal data processing')),			_('clone with minimal data processing')),
	] + remoteopts,			] + remoteopts,
	_('[OPTION]... SOURCE [DEST]'),			_('[OPTION]... SOURCE [DEST]'),
	norepo=True)			norepo=True)

This is an archive of the discontinued Mercurial Phabricator instance.

clone: updates the help text for hg clone -r (issue5654) [bugzilla] and hg clone -bClosedPublic

Details

Diff Detail

Event Timeline

Revision ContentsChangeset List

Diff 5371

mercurial/commands.py

clone: updates the help text for hg clone -r (issue5654) [bugzilla] and hg clone -b
ClosedPublic

Revision Contents
Changeset List