This is an archive of the discontinued Mercurial Phabricator instance.

Differential D8607

help: explain in `hg help flags` that unambiguous prefixes are allowed
ClosedPublic

Authored by martinvonz on Jun 4 2020, 2:50 AM.

Details

Reviewers
pulkit
Group Reviewers
hg-reviewers
Commits
rHG33ef8841da62: help: explain in `hg help flags` that unambiguous prefixes are allowed
Summary

I used hg commit --amend as an example because that's the most
frequently used flag I could think of that doesn't yet have a short
form.

Diff Detail

Repository
rHG Mercurial
Branch
default
Lint
No Linters Available
Unit
No Unit Test Coverage

Event Timeline

martinvonz created this revision.Jun 4 2020, 2:50 AM
pulkit accepted this revision.Jun 9 2020, 4:42 AM
This revision is now accepted and ready to land.Jun 9 2020, 4:42 AM

Revision Contents
Changeset List

PathPackages
Mmercurial/helptext/flags.txt (4 lines)

Diff 21550

mercurial/helptext/flags.txt

Most Mercurial commands accept various flags. Most Mercurial commands accept various flags.
Flag names Flag names
========== ==========
Flags for each command are listed in :hg:`help` for that command. Flags for each command are listed in :hg:`help` for that command.
Additionally, some flags, such as --repository, are global and can be used with Additionally, some flags, such as --repository, are global and can be used with
any command - those are seen in :hg:`help -v`, and can be specified before or any command - those are seen in :hg:`help -v`, and can be specified before or
after the command. after the command.
Every flag has at least a long name, such as --repository. Some flags may also Every flag has at least a long name, such as --repository. Some flags may also
have a short one-letter name, such as the equivalent -R. Using the short or long have a short one-letter name, such as the equivalent -R. Using the short or long
name is equivalent and has the same effect. name is equivalent and has the same effect. The long name may be abbreviated to
any unambiguous prefix. For example, :hg:`commit --amend` can be abbreviated
to :hg:`commit --am`.
Flags that have a short name can also be bundled together - for instance, to Flags that have a short name can also be bundled together - for instance, to
specify both --edit (short -e) and --interactive (short -i), one could use:: specify both --edit (short -e) and --interactive (short -i), one could use::
hg commit -ei hg commit -ei
If any of the bundled flags takes a value (i.e. is not a boolean), it must be If any of the bundled flags takes a value (i.e. is not a boolean), it must be
last, followed by the value:: last, followed by the value::