[PATCH 1 of 3] commands: switch help from -x/--extended to --extended
timeless
timeless at mozdev.org
Fri Dec 18 17:35:17 UTC 2015
# HG changeset patch
# User timeless <timeless at mozdev.org>
# Date 1450458403 0
# Fri Dec 18 17:06:43 2015 +0000
# Node ID 0f8b45c3bfcd9d6814d6f8238aeaaf998d75b33b
# Parent 2916ebaef3129451bfd4f9f62487e70f74124d46
commands: switch help from -x/--extended to --extended
This is an almost global replace.
Instances of -x short flags in samples should be retained,
but long forms should be favored in prose.
diff --git a/mercurial/commands.py b/mercurial/commands.py
--- a/mercurial/commands.py
+++ b/mercurial/commands.py
@@ -244,14 +244,14 @@
``.hgignore``. As with add, these changes take effect at the next
commit.
- Use the -s/--similarity option to detect renamed files. This
+ Use the --similarity option to detect renamed files. This
option takes a percentage between 0 (disabled) and 100 (files must
be identical) as its parameter. With a parameter greater than 0,
this compares every removed file with every added file and records
those similar enough as renames. Detecting renamed files this way
- can be expensive. After using this option, :hg:`status -C` can be
+ can be expensive. After using this option, :hg:`status --copies` can be
used to check which files were identified as moved or renamed. If
- not specified, -s/--similarity defaults to 100 and only renames of
+ not specified, --similarity defaults to 100 and only renames of
identical files are detected.
.. container:: verbose
@@ -329,8 +329,8 @@
This command is useful for discovering when a change was made and
by whom.
- Without the -a/--text option, annotate will avoid processing files
- it detects as binary. With -a, annotate will annotate the file
+ Without the --text option, annotate will avoid processing files
+ it detects as binary. With --text, annotate will annotate the file
anyway, although the results will probably be neither useful
nor desirable.
@@ -340,7 +340,7 @@
raise error.Abort(_('at least one filename or pattern is required'))
if opts.get('follow'):
- # --follow is deprecated and now just an alias for -f/--file
+ # --follow is deprecated and now just an alias for --file
# to mimic the behavior of Mercurial before version 1.5
opts['file'] = True
@@ -460,10 +460,10 @@
'''create an unversioned archive of a repository revision
By default, the revision used is the parent of the working
- directory; use -r/--rev to specify a different revision.
+ directory; use --rev to specify a different revision.
The archive type is automatically detected based on file
- extension (or override using -t/--type).
+ extension (or override using --type).
.. container:: verbose
@@ -490,7 +490,7 @@
using a format string; see :hg:`help export` for details.
Each member added to an archive file has a directory prefix
- prepended. Use -p/--prefix to specify a format string for the
+ prepended. Use --prefix to specify a format string for the
prefix. The default is the basename of the archive, with suffixes
removed.
@@ -573,7 +573,7 @@
cancel the merge and leave the child of REV as a head to be
merged separately.
- See :hg:`help dates` for a list of formats valid for -d/--date.
+ See :hg:`help dates` for a list of formats valid for --date.
See :hg:`help revert` for a way to restore files to the state
of another revision.
@@ -712,7 +712,7 @@
use, mark the earliest changeset you know exhibits the problem as
bad, then mark the latest changeset which is free from the problem
as good. Bisect will update your working directory to a revision
- for testing (unless the -U/--noupdate option is specified). Once
+ for testing (unless the --noupdate option is specified). Once
you have performed tests, mark the working directory as good or
bad, and bisect will either update to another candidate changeset
or announce that it has found the bad revision.
@@ -771,7 +771,7 @@
hg log -r "bisect(pruned)"
- see the changeset currently being bisected (especially useful
- if running with -U/--noupdate)::
+ if running with --noupdate)::
hg log -r "bisect(current)"
@@ -1177,10 +1177,10 @@
recommends that primary development take place on the 'default'
branch.
- Unless -f/--force is specified, branch will not let you set a
+ Unless --force is specified, branch will not let you set a
branch name that already exists.
- Use -C/--clean to reset the working directory branch to that of
+ Use --clean to reset the working directory branch to that of
the parent of the working directory, negating a previous branch
change.
@@ -1234,7 +1234,7 @@
"""list repository named branches
List the repository's named branches, indicating which ones are
- inactive. If -c/--closed is specified, also list branches which have
+ inactive. If --closed is specified, also list branches which have
been marked closed (see :hg:`commit --close-branch`).
Use the command :hg:`update` to switch to an existing branch.
@@ -1306,9 +1306,9 @@
If you omit the destination repository, then hg assumes the
destination will have all the nodes you specify with --base
parameters. To create a bundle containing all changesets, use
- -a/--all (or --base null).
-
- You can change bundle format with the -t/--type option. You can
+ --all (or --base null).
+
+ You can change bundle format with the --type option. You can
specify a compression, a bundle version or both using a dash
(comp-version). The available compression methods are: none, bzip2,
and gzip (by default, bundles are compressed using bzip2). The
@@ -1448,7 +1448,7 @@
``.hg/hgrc`` will be created on the remote side.
To pull only a subset of changesets, specify one or more revisions
- identifiers with -r/--rev or branches with -b/--branch. The
+ identifiers with --rev or branches with --branch. The
resulting clone will contain only the specified changesets and
their ancestors. These options (or 'clone src#rev dest') imply
--pull, even for local source repositories. Note that specifying a
@@ -1458,8 +1458,8 @@
If the source repository has a bookmark called '@' set, that
revision will be checked out in the new repository by default.
- To check out a particular version, use -u/--update, or
- -U/--noupdate to create a clone with no working directory.
+ To check out a particular version, use --update, or
+ --noupdate to create a clone with no working directory.
.. container:: verbose
@@ -1589,7 +1589,7 @@
It is not possible to amend public changesets (see :hg:`help phases`)
or changesets that have children.
- See :hg:`help dates` for a list of formats valid for -d/--date.
+ See :hg:`help dates` for a list of formats valid for --date.
Returns 0 on success, 1 if nothing changed.
@@ -1820,7 +1820,7 @@
the source must be a single file.
By default, this command copies the contents of files as they
- exist in the working directory. If invoked with -A/--after, the
+ exist in the working directory. If invoked with --after, the
operation is recorded, but no copying is performed.
This command takes effect with the next commit. To undo a copy
@@ -3536,14 +3536,14 @@
revisions are specified, the working directory files are compared
to its parent.
- Alternatively you can specify -c/--change with a revision to see
+ Alternatively you can specify --change with a revision to see
the changes in that changeset relative to its first parent.
- Without the -a/--text option, diff will avoid generating diffs of
+ Without the --text option, diff will avoid generating diffs of
files it detects as binary. With -a, diff will generate a diff
anyway, probably with undesirable results.
- Use the -g/--git option to generate diffs in the git extended diff
+ Use the --git option to generate diffs in the git extended diff
format. For more information, read :hg:`help diffs`.
.. container:: verbose
@@ -3634,11 +3634,11 @@
:``%n``: zero-padded sequence number, starting at 1
:``%r``: zero-padded changeset revision number
- Without the -a/--text option, export will avoid generating diffs
+ Without the --text option, export will avoid generating diffs
of files it detects as binary. With -a, export will generate a
diff anyway, probably with undesirable results.
- Use the -g/--git option to generate diffs in the git extended diff
+ Use the --git option to generate diffs in the git extended diff
format. See :hg:`help diffs` for more information.
With the --switch-parent option, the diff will be against the
@@ -3817,11 +3817,11 @@
If a graft merge results in conflicts, the graft process is
interrupted so that the current merge can be manually resolved.
Once all conflicts are addressed, the graft process can be
- continued with the -c/--continue option.
+ continued with the --continue option.
.. note::
- The -c/--continue option does not reapply earlier options, except
+ The --continue option does not reapply earlier options, except
for --force.
.. container:: verbose
@@ -4283,13 +4283,13 @@
means that you can use :hg:`heads .` to see the heads on the
currently checked-out branch.
- If -c/--closed is specified, also show branch heads marked closed
+ If --closed is specified, also show branch heads marked closed
(see :hg:`commit --close-branch`).
If STARTREV is specified, only those heads that are descendants of
STARTREV will be displayed.
- If -t/--topo is specified, named branch mechanics will be ignored and only
+ If --topo is specified, named branch mechanics will be ignored and only
topological heads (changesets with no children) will be shown.
Returns 0 if matching heads are found, 1 if not.
@@ -4595,7 +4595,7 @@
If the imported patch was generated by :hg:`export`, user and
description from patch override values from message headers and
- body. Values given on command line with -m/--message and -u/--user
+ body. Values given on command line with --message and --user
override these.
If --exact is specified, import will set the working directory to
@@ -4614,7 +4614,7 @@
cleanly, :hg:`import --partial` will create an empty changeset,
importing only the patch metadata.
- With -s/--similarity, hg will attempt to discover renames and
+ With --similarity, hg will attempt to discover renames and
copies in the patch in the same way as :hg:`addremove`.
It is possible to use external patch programs to perform the patch
@@ -4623,7 +4623,7 @@
See :hg:`help config` for more information about configuration
files and how to use these options.
- See :hg:`help dates` for a list of formats valid for -d/--date.
+ See :hg:`help dates` for a list of formats valid for --date.
.. container:: verbose
@@ -4777,8 +4777,8 @@
.. container:: verbose
- With -B/--bookmarks, the result of bookmark comparison between
- local and remote repositories is displayed. With -v/--verbose,
+ With --bookmarks, the result of bookmark comparison between
+ local and remote repositories is displayed. With --verbose,
status is also displayed for each bookmark like below::
BM1 01234567890a added
@@ -4949,13 +4949,13 @@
used as the starting revision.
File history is shown without following rename or copy history of
- files. Use -f/--follow with a filename to follow history across
+ files. Use --follow with a filename to follow history across
renames and copies. --follow without a filename will only show
ancestors or descendants of the starting revision.
By default this command prints revision number and changeset id,
tags, non-trivial parents, user, date and time, and a summary for
- each commit. When the -v/--verbose switch is used, the list of
+ each commit. When the --verbose switch is used, the list of
changed files and full commit message are shown.
With --graph the revisions are shown as an ASCII art DAG with the most
@@ -4966,7 +4966,7 @@
.. note::
- log -p/--patch may generate unexpected diff output for merge
+ log --patch may generate unexpected diff output for merge
changesets, as it will only compare the merge changeset against
its first parent. Also, only files different from BOTH parents
will appear in files:.
@@ -5025,7 +5025,7 @@
hg log -r "last(tagged())::" --template "{desc|firstline}\\n"
- See :hg:`help dates` for a list of formats valid for -d/--date.
+ See :hg:`help dates` for a list of formats valid for --date.
See :hg:`help revisions` and :hg:`help revsets` for more about
specifying revisions.
@@ -5227,8 +5227,8 @@
.. container:: verbose
- With -B/--bookmarks, the result of bookmark comparison between
- local and remote repositories is displayed. With -v/--verbose,
+ With --bookmarks, the result of bookmark comparison between
+ local and remote repositories is displayed. With --verbose,
status is also displayed for each bookmark like below::
BM1 01234567890a added
@@ -5290,7 +5290,7 @@
"""show the parents of the working directory or revision (DEPRECATED)
Print the working directory's parent revisions. If a revision is
- given via -r/--rev, the parent of that revision will be printed.
+ given via --rev, the parent of that revision will be printed.
If a file argument is given, the revision in which the file was
last changed (before the working directory revision or the
argument to --rev if given) is printed.
@@ -5344,7 +5344,7 @@
Show definition of symbolic path name NAME. If no name is given,
show definition of all available names.
- Option -q/--quiet suppresses all output when searching for NAME
+ Option --quiet suppresses all output when searching for NAME
and shows only the path names when listing all definitions.
Path names are defined in the [paths] section of your
@@ -5397,10 +5397,10 @@
With no argument, show the phase name of the current revision(s).
- With one of -p/--public, -d/--draft or -s/--secret, change the
+ With one of --public, --draft or --secret, change the
phase value of the specified revisions.
- Unless -f/--force is specified, :hg:`phase` won't move changeset from a
+ Unless --force is specified, :hg:`phase` won't move changeset from a
lower phase to an higher phase. Phases are ordered as follows::
public < draft < secret
@@ -5626,14 +5626,14 @@
.. note::
- Extra care should be taken with the -f/--force option,
+ Extra care should be taken with the --force option,
which will push all new heads on all branches, an action which will
almost always cause confusion for collaborators.
- If -r/--rev is used, the specified revision and all its ancestors
+ If --rev is used, the specified revision and all its ancestors
will be pushed to the remote repository.
- If -B/--bookmark is used, the specified bookmarked revision, its
+ If --bookmark is used, the specified bookmarked revision, its
ancestors, and the bookmark will be pushed to the remote
repository.
@@ -5730,8 +5730,8 @@
.. container:: verbose
- -A/--after can be used to remove only files that have already
- been deleted, -f/--force can be used to force deletion, and -Af
+ --after can be used to remove only files that have already
+ been deleted, --force can be used to force deletion, and -Af
can be used to remove files from the next revision without
deleting them from the working directory.
@@ -5777,7 +5777,7 @@
file, there can only be one source.
By default, this command copies the contents of files as they
- exist in the working directory. If invoked with -A/--after, the
+ exist in the working directory. If invoked with --after, the
operation is recorded, but no copying is performed.
This command takes effect at the next commit. To undo a rename
@@ -6021,7 +6021,7 @@
working directory has two parents, you must explicitly specify a
revision.
- Using the -r/--rev or -d/--date options, revert the given files or
+ Using the --rev or --date options, revert the given files or
directories to their states as of a specific revision. Because
revert does not change the working directory parents, this will
cause these files to appear modified. This can be helpful to "back
@@ -6031,7 +6031,7 @@
Modified files are saved with a .orig suffix before reverting.
To disable these backups, use --no-backup.
- See :hg:`help dates` for a list of formats valid for -d/--date.
+ See :hg:`help dates` for a list of formats valid for --date.
See :hg:`help backout` for a way to reverse the effect of an
earlier changeset.
@@ -6173,7 +6173,7 @@
should use a real web server if you need to authenticate users.
By default, the server logs accesses to stdout and errors to
- stderr. Use the -A/--accesslog and -E/--errorlog options to log to
+ stderr. Use the --accesslog and --errorlog options to log to
files.
To have the server choose a free port number to listen on, specify
@@ -6222,12 +6222,12 @@
Show status of files in the repository. If names are given, only
files that match are shown. Files that are clean or ignored or
the source of a copy/move operation, are not listed unless
- -c/--clean, -i/--ignored, -C/--copies or -A/--all are given.
+ --clean, --ignored, --copies or --all are given.
Unless options described with "show only ..." are given, the
options -mardu are used.
- Option -q/--quiet hides untracked (unknown and ignored) files
- unless explicitly requested with -u/--unknown or -i/--ignored.
+ Option --quiet hides untracked (unknown and ignored) files
+ unless explicitly requested with --unknown or --ignored.
.. note::
@@ -6611,7 +6611,7 @@
('l', 'local', None, _('make the tag local')),
('r', 'rev', '', _('revision to tag'), _('REV')),
('', 'remove', None, _('remove a tag')),
- # -l/--local is already there, commitopts cannot be used
+ # --local is already there, commitopts cannot be used
('e', 'edit', None, _('invoke editor on commit messages')),
('m', 'message', '', _('use text as commit message'), _('TEXT')),
] + commitopts2,
@@ -6624,7 +6624,7 @@
Tags are used to name particular revisions of the repository and are
very useful to compare different revisions, to go back to significant
earlier versions or to mark branch points as releases, etc. Changing
- an existing tag is normally disallowed; use -f/--force to override.
+ an existing tag is normally disallowed; use --force to override.
If no revision is given, the parent of the working directory is
used.
@@ -6638,10 +6638,10 @@
Tag commits are usually made at the head of a branch. If the parent
of the working directory is not a branch head, :hg:`tag` aborts; use
- -f/--force to force the tag commit to be based on a non-head
+ --force to force the tag commit to be based on a non-head
changeset.
- See :hg:`help dates` for a list of formats valid for -d/--date.
+ See :hg:`help dates` for a list of formats valid for --date.
Since tag names have priority over branch names during revision
lookup, using an existing branch name as a tag name is discouraged.
@@ -6727,7 +6727,7 @@
def tags(ui, repo, **opts):
"""list repository tags
- This lists both regular and local tags. When the -v/--verbose
+ This lists both regular and local tags. When the --verbose
switch is used, a third column "local" is printed for local tags.
Returns 0 on success.
@@ -6850,7 +6850,7 @@
changeset (see :hg:`help parents`).
If the changeset is not a descendant or ancestor of the working
- directory's parent, the update is aborted. With the -c/--check
+ directory's parent, the update is aborted. With the --check
option, the working directory is checked for uncommitted changes; if
none are found, the working directory is updated to the specified
changeset.
@@ -6860,7 +6860,7 @@
The following rules apply when the working directory contains
uncommitted changes:
- 1. If neither -c/--check nor -C/--clean is specified, and if
+ 1. If neither --check nor --clean is specified, and if
the requested changeset is an ancestor or descendant of
the working directory's parent, the uncommitted changes
are merged into the requested changeset and the merged
@@ -6869,22 +6869,22 @@
branch), the update is aborted and the uncommitted changes
are preserved.
- 2. With the -c/--check option, the update is aborted and the
+ 2. With the --check option, the update is aborted and the
uncommitted changes are preserved.
- 3. With the -C/--clean option, uncommitted changes are discarded and
+ 3. With the --clean option, uncommitted changes are discarded and
the working directory is updated to the requested changeset.
To cancel an uncommitted merge (and lose your changes), use
:hg:`update --clean .`.
Use null as the changeset to remove the working directory (like
- :hg:`clone -U`).
+ :hg:`clone --noupdate`).
If you want to revert just one file to an older revision, use
:hg:`revert [-r REV] NAME`.
- See :hg:`help dates` for a list of formats valid for -d/--date.
+ See :hg:`help dates` for a list of formats valid for --date.
Returns 0 on success, 1 if there are unresolved files.
"""
diff --git a/tests/test-help.t b/tests/test-help.t
--- a/tests/test-help.t
+++ b/tests/test-help.t
@@ -505,14 +505,14 @@
compared to the working directory, and, when no revisions are specified,
the working directory files are compared to its parent.
- Alternatively you can specify -c/--change with a revision to see the
- changes in that changeset relative to its first parent.
+ Alternatively you can specify --change with a revision to see the changes
+ in that changeset relative to its first parent.
- Without the -a/--text option, diff will avoid generating diffs of files it
+ Without the --text option, diff will avoid generating diffs of files it
detects as binary. With -a, diff will generate a diff anyway, probably
with undesirable results.
- Use the -g/--git option to generate diffs in the git extended diff format.
+ Use the --git option to generate diffs in the git extended diff format.
For more information, read "hg help diffs".
Returns 0 on success.
@@ -548,12 +548,12 @@
Show status of files in the repository. If names are given, only files
that match are shown. Files that are clean or ignored or the source of a
- copy/move operation, are not listed unless -c/--clean, -i/--ignored,
- -C/--copies or -A/--all are given. Unless options described with "show
- only ..." are given, the options -mardu are used.
+ copy/move operation, are not listed unless --clean, --ignored, --copies or
+ --all are given. Unless options described with "show only ..." are given,
+ the options -mardu are used.
- Option -q/--quiet hides untracked (unknown and ignored) files unless
- explicitly requested with -u/--unknown or -i/--ignored.
+ Option --quiet hides untracked (unknown and ignored) files unless
+ explicitly requested with --unknown or --ignored.
Note:
status may appear to disagree with diff if permissions have changed or
@@ -2379,8 +2379,8 @@
files, see "hg forget".
</p>
<p>
- -A/--after can be used to remove only files that have already
- been deleted, -f/--force can be used to force deletion, and -Af
+ --after can be used to remove only files that have already
+ been deleted, --force can be used to force deletion, and -Af
can be used to remove files from the next revision without
deleting them from the working directory.
</p>
More information about the Mercurial-devel
mailing list