Bug 5654 - Help text for clone -r option is unclear
Summary: Help text for clone -r option is unclear
Status: RESOLVED FIXED
Alias: None
Product: Mercurial
Classification: Unclassified
Component: Mercurial (show other bugs)
Version: 3.8.4
Hardware: PC Windows
: wish bug
Assignee: Bugzilla
URL:
Keywords: easy
Depends on:
Blocks:
 
Reported: 2017-08-11 21:57 UTC by David Hollman
Modified: 2018-03-11 00:00 UTC (History)
3 users (show)

See Also:
Python Version: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description David Hollman 2017-08-11 21:57 UTC
The help text shown for the -r option to clone is:

"include the specified changeset"


To the best of my understanding while this is technically a true statement it does not seem like a complete description of the -r option.

Note - the web documentation at https://www.selenic.com/mercurial/hg.1.html#clone does give an example where it explains that -r will "create a repository without changesets after a particular revision". This seems better, but still a somewhat stilted way of making the core point.

It would make more sense to me if it said something like "clone up to and including the specified changeset".
Comment 1 Bugzilla 2017-09-11 00:00 UTC
Bug was set to UNCONFIRMED for 30 days, bumping
Comment 2 Augie Fackler 2017-09-29 10:17 UTC
Sounds like a reasonable help text tweak.
Comment 3 Denis Laxalde 2018-02-09 09:40 UTC
The help already says:

    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.

Isn't this enough?
Comment 4 HG Bot 2018-03-03 15:25 UTC
Fixed by https://mercurial-scm.org/repo/hg/rev/4de15c54e59f
Sangeet Kumar Mishra <mail2sangeetmishra@gmail.com>
clone: updates the help text for hg clone -{r,b} (issue5654)

Differential Revision: https://phab.mercurial-scm.org/D2095

(please test the fix)
Comment 5 Bugzilla 2018-03-11 00:00 UTC
Bug was set to TESTING for 7 days, resolving