mercurial-scm/hg-stable: mercurial/commands.py comparison

comparison mercurial/commands.py @ 9051:f8e25885d975

commands: wrapped docstrings at 78 characters We have always had a left margin of 4 characters -- probably just because that's how docstrings for top-level functions turn out by default, but it also looks nice in the built-in help. The docstrings were wrapped at 70 characters, which is the default for Emacs. However, this gives a right margin of 10 characters in a standard 80 character terminal. I've now wrapped the relevant docstrings at 78 characters, effectively killing the right margin. The asymmetric margins looked a bit odd and some of the text looked cramped with a right margin, so Dirkjan and I felt that it was best to remove it entirely. The two character gap was kept to have some space between the border of the terminal -- it will also make diffs involving the docstrings fit in a 80 character line.

author	Martin Geisler <mg@lazybytes.net>
date	Tue, 07 Jul 2009 23:54:30 +0200
parents	32e678f9045f
children	5d6c42f33b71

comparison

equal deleted inserted replaced

-:77324df822e2
+:f8e25885d975
 # Commands start here, listed alphabetically
 def add(ui, repo, *pats, **opts):
 """add the specified files on the next commit
-Schedule files to be version controlled and added to the
+Schedule files to be version controlled and added to the repository.
-repository.
+The files will be added to the repository at the next commit. To undo an
-The files will be added to the repository at the next commit. To
+add before that, see hg forget.
-undo an add before that, see hg forget.
 If no names are given, add all files to the repository.
 """
 bad = []
 return bad and 1 or 0
 def addremove(ui, repo, *pats, **opts):
 """add all new files, delete all missing files
-Add all new files and remove all missing files from the
+Add all new files and remove all missing files from the repository.
-repository.
+New files are ignored if they match any of the patterns in .hgignore. As
-New files are ignored if they match any of the patterns in
+with add, these changes take effect at the next commit.
-.hgignore. As with add, these changes take effect at the next
-commit.
+Use the -s/--similarity option to detect renamed files. With a parameter >
+0, this compares every removed file with every added file and records
-Use the -s/--similarity option to detect renamed files. With a
+those similar enough as renames. This option takes a percentage between 0
-parameter > 0, this compares every removed file with every added
+(disabled) and 100 (files must be identical) as its parameter. Detecting
-file and records those similar enough as renames. This option
+renamed files this way can be expensive.
-takes a percentage between 0 (disabled) and 100 (files must be
-identical) as its parameter. Detecting renamed files this way can
-be expensive.
 """
 try:
 sim = float(opts.get('similarity') or 0)
 except ValueError:
 raise util.Abort(_('similarity must be a number'))
 return cmdutil.addremove(repo, pats, opts, similarity=sim/100.)
 def annotate(ui, repo, *pats, **opts):
 """show changeset information by line for each file
-List changes in files, showing the revision id responsible for
+List changes in files, showing the revision id responsible for each line
-each line
+This command is useful for discovering when a change was made and by whom.
-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 anyway,
-Without the -a/--text option, annotate will avoid processing files
+although the results will probably be neither useful nor desirable.
-it detects as binary. With -a, annotate will annotate the file
-anyway, although the results will probably be neither useful
-nor desirable.
 """
 datefunc = ui.quiet and util.shortdate or util.datestr
 getdate = util.cachefunc(lambda x: datefunc(x[0].date()))
 if not pats:
 ui.write("%s: %s" % (" ".join(p), l[1]))
 def archive(ui, repo, dest, **opts):
 '''create an unversioned archive of a repository revision
-By default, the revision used is the parent of the working
+By default, the revision used is the parent of the working directory; use
-directory; use -r/--rev to specify a different revision.
+-r/--rev to specify a different revision.
-To specify the type of archive to create, use -t/--type. Valid
+To specify the type of archive to create, use -t/--type. Valid types are:
-types are:
 "files" (default): a directory full of files
 "tar": tar archive, uncompressed
 "tbz2": tar archive, compressed using bzip2
 "tgz": tar archive, compressed using gzip
 "uzip": zip archive, uncompressed
 "zip": zip archive, compressed using deflate
-The exact name of the destination archive or directory is given
+The exact name of the destination archive or directory is given using a
-using a format string; see 'hg help export' for details.
+format string; see 'hg help export' for details.
-Each member added to an archive file has a directory prefix
+Each member added to an archive file has a directory prefix prepended. Use
-prepended. Use -p/--prefix to specify a format string for the
+-p/--prefix to specify a format string for the prefix. The default is the
-prefix. The default is the basename of the archive, with suffixes
+basename of the archive, with suffixes removed.
-removed.
 '''
 ctx = repo[opts.get('rev')]
 if not ctx:
 raise util.Abort(_('no working directory: please specify a revision'))
 matchfn, prefix)
 def backout(ui, repo, node=None, rev=None, **opts):
 '''reverse effect of earlier changeset
-Commit the backed out changes as a new changeset. The new
+Commit the backed out changes as a new changeset. The new changeset is a
-changeset is a child of the backed out changeset.
+child of the backed out changeset.
-If you backout a changeset other than the tip, a new head is
+If you backout a changeset other than the tip, a new head is created. This
-created. This head will be the new tip and you should merge this
+head will be the new tip and you should merge this backout changeset with
-backout changeset with another head.
+another head.
-The --merge option remembers the parent of the working directory
+The --merge option remembers the parent of the working directory before
-before starting the backout, then merges the new head with that
+starting the backout, then merges the new head with that changeset
-changeset afterwards. This saves you from doing the merge by hand.
+afterwards. This saves you from doing the merge by hand. The result of
-The result of this merge is not committed, as with a normal merge.
+this merge is not committed, as with a normal merge.
 See 'hg help dates' for a list of formats valid for -d/--date.
 '''
 if rev and node:
 raise util.Abort(_("please specify just one revision"))
 def bisect(ui, repo, rev=None, extra=None, command=None,
 reset=None, good=None, bad=None, skip=None, noupdate=None):
 """subdivision search of changesets
-This command helps to find changesets which introduce problems. To
+This command helps to find changesets which introduce problems. To use,
-use, mark the earliest changeset you know exhibits the problem as
+mark the earliest changeset you know exhibits the problem as bad, then
-bad, then mark the latest changeset which is free from the problem
+mark the latest changeset which is free from the problem as good. Bisect
-as good. Bisect will update your working directory to a revision
+will update your working directory to a revision for testing (unless the
-for testing (unless the -U/--noupdate option is specified). Once
+-U/--noupdate option is specified). Once you have performed tests, mark
-you have performed tests, mark the working directory as good or
+the working directory as good or bad, and bisect will either update to
-bad, and bisect will either update to another candidate changeset
+another candidate changeset or announce that it has found the bad
-or announce that it has found the bad revision.
+revision.
-As a shortcut, you can also use the revision argument to mark a
+As a shortcut, you can also use the revision argument to mark a revision
-revision as good or bad without checking it out first.
+as good or bad without checking it out first.
-If you supply a command, it will be used for automatic bisection.
+If you supply a command, it will be used for automatic bisection. Its exit
-Its exit status will be used to mark revisions as good or bad:
+status will be used to mark revisions as good or bad: status 0 means good,
-status 0 means good, 125 means to skip the revision, 127
+125 means to skip the revision, 127 (command not found) will abort the
-(command not found) will abort the bisection, and any other
+bisection, and any other non-zero exit status means the revision is bad.
-non-zero exit status means the revision is bad.
 """
 def print_result(nodes, good):
 displayer = cmdutil.show_changeset(ui, repo, {})
 if len(nodes) == 1:
 # narrowed it down to a single revision
 return hg.clean(repo, node)
 def branch(ui, repo, label=None, **opts):
 """set or show the current branch name
-With no argument, show the current branch name. With one argument,
+With no argument, show the current branch name. With one argument, set the
-set the working directory branch name (the branch will not exist
+working directory branch name (the branch will not exist in the repository
-in the repository until the next commit). Standard practice
+until the next commit). Standard practice recommends that primary
-recommends that primary development take place on the 'default'
+development take place on the 'default' branch.
-branch.
+Unless -f/--force is specified, branch will not let you set a branch name
-Unless -f/--force is specified, branch will not let you set a
+that already exists, even if it's inactive.
-branch name that already exists, even if it's inactive.
+Use -C/--clean to reset the working directory branch to that of the parent
-Use -C/--clean to reset the working directory branch to that of
+of the working directory, negating a previous branch change.
-the parent of the working directory, negating a previous branch
-change.
+Use the command 'hg update' to switch to an existing branch. Use 'hg
+commit --close-branch' to mark this branch as closed.
-Use the command 'hg update' to switch to an existing branch. Use
-'hg commit --close-branch' to mark this branch as closed.
 """
 if opts.get('clean'):
 label = repo[None].parents()[0].branch()
 repo.dirstate.setbranch(label)
 ui.write("%s\n" % encoding.tolocal(repo.dirstate.branch()))
 def branches(ui, repo, active=False, closed=False):
 """list repository named branches
-List the repository's named branches, indicating which ones are
+List the repository's named branches, indicating which ones are inactive.
-inactive. If -c/--closed is specified, also list branches which have
+If -c/--closed is specified, also list branches which have been marked
-been marked closed (see hg commit --close-branch).
+closed (see hg commit --close-branch).
-If -a/--active is specified, only show active branches. A branch
+If -a/--active is specified, only show active branches. A branch is
-is considered active if it contains repository heads.
+considered active if it contains repository heads.
 Use the command 'hg update' to switch to an existing branch.
 """
 hexfunc = ui.debugflag and hex or short
 ui.write("%s %s:%s%s\n" % data)
 def bundle(ui, repo, fname, dest=None, **opts):
 """create a changegroup file
-Generate a compressed changegroup file collecting changesets not
+Generate a compressed changegroup file collecting changesets not known to
-known to be in another repository.
+be in another repository.
-If no destination repository is specified the destination is
+If no destination repository is specified the destination is assumed to
-assumed to have all the nodes specified by one or more --base
+have all the nodes specified by one or more --base parameters. To create a
-parameters. To create a bundle containing all changesets, use
+bundle containing all changesets, use -a/--all (or --base null).
--a/--all (or --base null).
+You can change compression method with the -t/--type option. The available
-You can change compression method with the -t/--type option.
+compression methods are: none, bzip2, and gzip (by default, bundles are
-The available compression methods are: none, bzip2, and
+compressed using bzip2).
-gzip (by default, bundles are compressed using bzip2).
+The bundle file can then be transferred using conventional means and
-The bundle file can then be transferred using conventional means
+applied to another repository with the unbundle or pull command. This is
-and applied to another repository with the unbundle or pull
+useful when direct push and pull are not available or when exporting an
-command. This is useful when direct push and pull are not
+entire repository is undesirable.
-available or when exporting an entire repository is undesirable.
+Applying bundles preserves all changeset contents including permissions,
-Applying bundles preserves all changeset contents including
+copy/rename information, and revision history.
-permissions, copy/rename information, and revision history.
 """
 revs = opts.get('rev') or None
 if revs:
 revs = [repo.lookup(rev) for rev in revs]
 if opts.get('all'):
 changegroup.writebundle(cg, fname, bundletype)
 def cat(ui, repo, file1, *pats, **opts):
 """output the current or given revision of files
-Print the specified files as they were at the given revision. If
+Print the specified files as they were at the given revision. If no
-no revision is given, the parent of the working directory is used,
+revision is given, the parent of the working directory is used, or tip if
-or tip if no revision is checked out.
+no revision is checked out.
-Output may be to a file, in which case the name of the file is
+Output may be to a file, in which case the name of the file is given using
-given using a format string. The formatting rules are the same as
+a format string. The formatting rules are the same as for the export
-for the export command, with the following additions:
+command, with the following additions:
 %s   basename of file being printed
 %d   dirname of file being printed, or '.' if in repository root
 %p   root-relative path name of file being printed
 """
 def clone(ui, source, dest=None, **opts):
 """make a copy of an existing repository
 Create a copy of an existing repository in a new directory.
-If no destination directory name is specified, it defaults to the
+If no destination directory name is specified, it defaults to the basename
-basename of the source.
+of the source.
-The location of the source is added to the new repository's
+The location of the source is added to the new repository's .hg/hgrc file,
-.hg/hgrc file, as the default to be used for future pulls.
+as the default to be used for future pulls.
-If you use the -r/--rev option to clone up to a specific revision,
+If you use the -r/--rev option to clone up to a specific revision, no
-no subsequent revisions (including subsequent tags) will be
+subsequent revisions (including subsequent tags) will be present in the
-present in the cloned repository. This option implies --pull, even
+cloned repository. This option implies --pull, even on local repositories.
-on local repositories.
+By default, clone will check out the head of the 'default' branch. If the
-By default, clone will check out the head of the 'default' branch.
+-U/--noupdate option is used, the new clone will contain only a repository
-If the -U/--noupdate option is used, the new clone will contain
+(.hg) and no working copy (the working copy parent is the null revision).
-only a repository (.hg) and no working copy (the working copy
-parent is the null revision).
 See 'hg help urls' for valid source format details.
 It is possible to specify an ssh:// URL as the destination, but no
-.hg/hgrc and working directory will be created on the remote side.
+.hg/hgrc and working directory will be created on the remote side. Please
-Please see 'hg help urls' for important details about ssh:// URLs.
+see 'hg help urls' for important details about ssh:// URLs.
-For efficiency, hardlinks are used for cloning whenever the source
+For efficiency, hardlinks are used for cloning whenever the source and
-and destination are on the same filesystem (note this applies only
+destination are on the same filesystem (note this applies only to the
-to the repository data, not to the checked out files). Some
+repository data, not to the checked out files). Some filesystems, such as
-filesystems, such as AFS, implement hardlinking incorrectly, but
+AFS, implement hardlinking incorrectly, but do not report errors. In these
-do not report errors. In these cases, use the --pull option to
+cases, use the --pull option to avoid hardlinking.
-avoid hardlinking.
+In some cases, you can clone repositories and checked out files using full
-In some cases, you can clone repositories and checked out files
+hardlinks with
-using full hardlinks with
 $ cp -al REPO REPOCLONE
-This is the fastest way to clone, but it is not always safe. The
+This is the fastest way to clone, but it is not always safe. The operation
-operation is not atomic (making sure REPO is not modified during
+is not atomic (making sure REPO is not modified during the operation is up
-the operation is up to you) and you have to make sure your editor
+to you) and you have to make sure your editor breaks hardlinks (Emacs and
-breaks hardlinks (Emacs and most Linux Kernel tools do so). Also,
+most Linux Kernel tools do so). Also, this is not compatible with certain
-this is not compatible with certain extensions that place their
+extensions that place their metadata under the .hg directory, such as mq.
-metadata under the .hg directory, such as mq.
 """
 hg.clone(cmdutil.remoteui(ui, opts), source, dest,
 pull=opts.get('pull'),
 stream=opts.get('uncompressed'),
 rev=opts.get('rev'),
 def commit(ui, repo, *pats, **opts):
 """commit the specified files or all outstanding changes
 Commit changes to the given files into the repository. Unlike a
-centralized RCS, this operation is a local operation. See hg push
+centralized RCS, this operation is a local operation. See hg push for a
-for a way to actively distribute your changes.
+way to actively distribute your changes.
-If a list of files is omitted, all changes reported by "hg status"
+If a list of files is omitted, all changes reported by "hg status" will be
-will be committed.
+committed.
-If you are committing the result of a merge, do not provide any
+If you are committing the result of a merge, do not provide any filenames
-filenames or -I/-X filters.
+or -I/-X filters.
-If no commit message is specified, the configured editor is
+If no commit message is specified, the configured editor is started to
-started to prompt you for a message.
+prompt you for a message.
 See 'hg help dates' for a list of formats valid for -d/--date.
 """
 extra = {}
 if opts.get('close_branch'):
 ui.write(_('committed changeset %d:%s\n') % (rev,short(node)))
 def copy(ui, repo, *pats, **opts):
 """mark files as copied for the next commit
-Mark dest as having copies of source files. If dest is a
+Mark dest as having copies of source files. If dest is a directory, copies
-directory, copies are put in that directory. If dest is a file,
+are put in that directory. If dest is a file, the source must be a single
-the source must be a single file.
+file.
-By default, this command copies the contents of files as they
+By default, this command copies the contents of files as they exist in the
-exist in the working directory. If invoked with -A/--after, the
+working directory. If invoked with -A/--after, the operation is recorded,
-operation is recorded, but no copying is performed.
+but no copying is performed.
-This command takes effect with the next commit. To undo a copy
+This command takes effect with the next commit. To undo a copy before
-before that, see hg revert.
+that, see hg revert.
 """
 wlock = repo.wlock(False)
 try:
 return cmdutil.copy(ui, repo, pats, opts)
 finally:
 def showconfig(ui, repo, *values, **opts):
 """show combined config settings from all hgrc files
 With no arguments, print names and values of all config items.
-With one argument of the form section.name, print just the value
+With one argument of the form section.name, print just the value of that
-of that config item.
+config item.
-With multiple arguments, print names and values of all config
+With multiple arguments, print names and values of all config items with
-items with matching section names.
+matching section names.
-With --debug, the source (filename and line number) is printed
+With --debug, the source (filename and line number) is printed for each
-for each config item.
+config item.
 """
 untrusted = bool(opts.get('untrusted'))
 if values:
 if len([v for v in values if '.' in v]) > 1:
 ui.write('%s=%s\n' % (sectname, value))
 def debugsetparents(ui, repo, rev1, rev2=None):
 """manually set the parents of the current working directory
-This is useful for writing repository conversion tools, but should
+This is useful for writing repository conversion tools, but should be used
-be used with care.
+with care.
 """
 if not rev2:
 rev2 = hex(nullid)
 Show differences between revisions for the specified files.
 Differences between files are shown using the unified diff format.
-NOTE: diff may generate unexpected results for merges, as it will
+NOTE: diff may generate unexpected results for merges, as it will default
-default to comparing against the working directory's first parent
+to comparing against the working directory's first parent changeset if no
-changeset if no revisions are specified.
+revisions are specified.
-When two revision arguments are given, then changes are shown
+When two revision arguments are given, then changes are shown between
-between those revisions. If only one revision is specified then
+those revisions. If only one revision is specified then that revision is
-that revision is compared to the working directory, and, when no
+compared to the working directory, and, when no revisions are specified,
-revisions are specified, the working directory files are compared
+the working directory files are compared to its parent.
-to its parent.
+Without the -a/--text option, diff will avoid generating diffs of files it
-Without the -a/--text option, diff will avoid generating diffs of
+detects as binary. With -a, diff will generate a diff anyway, probably
-files it detects as binary. With -a, diff will generate a diff
+with undesirable results.
-anyway, probably with undesirable results.
+Use the -g/--git option to generate diffs in the git extended diff format.
-Use the -g/--git option to generate diffs in the git extended diff
+For more information, read 'hg help diffs'.
-format. For more information, read 'hg help diffs'.
 """
 revs = opts.get('rev')
 change = opts.get('change')
 def export(ui, repo, *changesets, **opts):
 """dump the header and diffs for one or more changesets
 Print the changeset header and diffs for one or more revisions.
-The information shown in the changeset header is: author,
+The information shown in the changeset header is: author, changeset hash,
-changeset hash, parent(s) and commit comment.
+parent(s) and commit comment.
-NOTE: export may generate unexpected diff output for merge
+NOTE: export may generate unexpected diff output for merge changesets, as
-changesets, as it will compare the merge changeset against its
+it will compare the merge changeset against its first parent only.
-first parent only.
+Output may be to a file, in which case the name of the file is given using
-Output may be to a file, in which case the name of the file is
+a format string. The formatting rules are as follows:
-given using a format string. The formatting rules are as follows:
 %%   literal "%" character
 %H   changeset hash (40 bytes of hexadecimal)
 %N   number of patches being generated
 %R   changeset revision number
 %b   basename of the exporting repository
 %h   short-form changeset hash (12 bytes of hexadecimal)
 %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 -a/--text option, export will avoid generating diffs of files
-of files it detects as binary. With -a, export will generate a
+it detects as binary. With -a, export will generate a diff anyway,
-diff anyway, probably with undesirable results.
+probably with undesirable results.
-Use the -g/--git option to generate diffs in the git extended diff
+Use the -g/--git option to generate diffs in the git extended diff format.
-format. See 'hg help diffs' for more information.
+See 'hg help diffs' for more information.
-With the --switch-parent option, the diff will be against the
+With the --switch-parent option, the diff will be against the second
-second parent. It can be useful to review a merge.
+parent. It can be useful to review a merge.
 """
 if not changesets:
 raise util.Abort(_("export requires at least one changeset"))
 revs = cmdutil.revrange(repo, changesets)
 if len(revs) > 1:
 opts=patch.diffopts(ui, opts))
 def forget(ui, repo, *pats, **opts):
 """forget the specified files on the next commit
-Mark the specified files so they will no longer be tracked
+Mark the specified files so they will no longer be tracked after the next
-after the next commit.
+commit.
-This only removes files from the current branch, not from the
+This only removes files from the current branch, not from the entire
-entire project history, and it does not delete them from the
+project history, and it does not delete them from the working directory.
-working directory.
 To undo a forget before the next commit, see hg add.
 """
 if not pats:
 """search for a pattern in specified files and revisions
 Search revisions of files for a regular expression.
 This command behaves differently than Unix grep. It only accepts
-Python/Perl regexps. It searches repository history, not the
+Python/Perl regexps. It searches repository history, not the working
-working directory. It always prints the revision number in which a
+directory. It always prints the revision number in which a match appears.
-match appears.
+By default, grep only prints output for the first revision of a file in
-By default, grep only prints output for the first revision of a
+which it finds a match. To get it to print every revision that contains a
-file in which it finds a match. To get it to print every revision
+change in match status ("-" for a match that becomes a non-match, or "+"
-that contains a change in match status ("-" for a match that
+for a non-match that becomes a match), use the --all flag.
-becomes a non-match, or "+" for a non-match that becomes a match),
-use the --all flag.
 """
 reflags = 0
 if opts.get('ignore_case'):
 reflags |= re.I
 try:
 def heads(ui, repo, *branchrevs, **opts):
 """show current repository heads or show branch heads
 With no arguments, show all repository head changesets.
-Repository "heads" are changesets that don't have child
+Repository "heads" are changesets that don't have child changesets. They
-changesets. They are where development generally takes place and
+are where development generally takes place and are the usual targets for
-are the usual targets for update and merge operations.
+update and merge operations.
-If one or more REV is given, the "branch heads" will be shown for
+If one or more REV is given, the "branch heads" will be shown for the
-the named branch associated with that revision. The name of the
+named branch associated with that revision. The name of the branch is
-branch is called the revision's branch tag.
+called the revision's branch tag.
-Branch heads are revisions on a given named branch that do not have
+Branch heads are revisions on a given named branch that do not have any
-any descendants on the same branch. A branch head could be a true head
+descendants on the same branch. A branch head could be a true head or it
-or it could be the last changeset on a branch before a new branch
+could be the last changeset on a branch before a new branch was created.
-was created. If none of the branch heads are true heads, the branch
+If none of the branch heads are true heads, the branch is considered
-is considered inactive. If -c/--closed is specified, also show branch
+inactive. If -c/--closed is specified, also show branch heads marked
-heads marked closed (see hg commit --close-branch).
+closed (see hg commit --close-branch).
-If STARTREV is specified only those heads (or branch heads) that
+If STARTREV is specified only those heads (or branch heads) that are
-are descendants of STARTREV will be displayed.
+descendants of STARTREV will be displayed.
 """
 if opts.get('rev'):
 start = repo.lookup(opts['rev'])
 else:
 start = None
 def help_(ui, name=None, with_version=False):
 """show help for a given topic or a help overview
 With no arguments, print a list of commands with short help messages.
-Given a topic, extension, or command name, print help for that
+Given a topic, extension, or command name, print help for that topic.
-topic."""
+"""
 option_lists = []
 def addglobalopts(aliases):
 if ui.verbose:
 option_lists.append((_("global options:"), globalopts))
 def identify(ui, repo, source=None,
 rev=None, num=None, id=None, branch=None, tags=None):
 """identify the working copy or specified revision
-With no revision, print a summary of the current state of the
+With no revision, print a summary of the current state of the repository.
-repository.
+Specifying a path to a repository root or Mercurial bundle will cause
-Specifying a path to a repository root or Mercurial bundle will
+lookup to operate on that repository/bundle.
-cause lookup to operate on that repository/bundle.
+This summary identifies the repository state using one or two parent hash
-This summary identifies the repository state using one or two
+identifiers, followed by a "+" if there are uncommitted changes in the
-parent hash identifiers, followed by a "+" if there are
+working directory, a list of tags for this revision and a branch name for
-uncommitted changes in the working directory, a list of tags for
+non-default branches.
-this revision and a branch name for non-default branches.
 """
 if not repo and not source:
 raise util.Abort(_("There is no Mercurial repository here "
 "(.hg not found)"))
 def import_(ui, repo, patch1, *patches, **opts):
 """import an ordered set of patches
 Import a list of patches and commit them individually.
-If there are outstanding changes in the working directory, import
+If there are outstanding changes in the working directory, import will
-will abort unless given the -f/--force flag.
+abort unless given the -f/--force flag.
-You can import a patch straight from a mail message. Even patches
+You can import a patch straight from a mail message. Even patches as
-as attachments work (to use the body part, it must have type
+attachments work (to use the body part, it must have type text/plain or
-text/plain or text/x-patch). From and Subject headers of email
+text/x-patch). From and Subject headers of email message are used as
-message are used as default committer and commit message. All
+default committer and commit message. All text/plain body parts before
-text/plain body parts before first diff are added to commit
+first diff are added to commit message.
-message.
+If the imported patch was generated by hg export, user and description
-If the imported patch was generated by hg export, user and
+from patch override values from message headers and body. Values given on
-description from patch override values from message headers and
+command line with -m/--message and -u/--user override these.
-body. Values given on command line with -m/--message and -u/--user
-override these.
+If --exact is specified, import will set the working directory to the
+parent of each patch before applying it, and will abort if the resulting
-If --exact is specified, import will set the working directory to
+changeset has a different ID than the one recorded in the patch. This may
-the parent of each patch before applying it, and will abort if the
+happen due to character set problems or other deficiencies in the text
-resulting changeset has a different ID than the one recorded in
+patch format.
-the patch. This may happen due to character set problems or other
-deficiencies in the text patch format.
+With -s/--similarity, hg will attempt to discover renames and copies in
+the patch in the same way as 'addremove'.
-With -s/--similarity, hg will attempt to discover renames and
-copies in the patch in the same way as 'addremove'.
+To read a patch from standard input, use "-" as the patch name. If a URL
+is specified, the patch will be downloaded from it. See 'hg help dates'
-To read a patch from standard input, use "-" as the patch name. If
+for a list of formats valid for -d/--date.
-a URL is specified, the patch will be downloaded from it.
-See 'hg help dates' for a list of formats valid for -d/--date.
 """
 patches = (patch1,) + patches
 date = opts.get('date')
 if date:
 release(lock, wlock)
 def incoming(ui, repo, source="default", **opts):
 """show new changesets found in source
-Show new changesets found in the specified path/URL or the default
+Show new changesets found in the specified path/URL or the default pull
-pull location. These are the changesets that would have been pulled
+location. These are the changesets that would have been pulled if a pull
-if a pull at the time you issued this command.
+at the time you issued this command.
-For remote repository, using --bundle avoids downloading the
+For remote repository, using --bundle avoids downloading the changesets
-changesets twice if the incoming is followed by a pull.
+twice if the incoming is followed by a pull.
 See pull for valid source format details.
 """
 limit = cmdutil.loglimit(opts)
 source, revs, checkout = hg.parseurl(ui.expandpath(source), opts.get('rev'))
 os.unlink(cleanup)
 def init(ui, dest=".", **opts):
 """create a new repository in the given directory
-Initialize a new repository in the given directory. If the given
+Initialize a new repository in the given directory. If the given directory
-directory does not exist, it will be created.
+does not exist, it will be created.
 If no directory is given, the current directory is used.
-It is possible to specify an ssh:// URL as the destination.
+It is possible to specify an ssh:// URL as the destination. See 'hg help
-See 'hg help urls' for more information.
+urls' for more information.
 """
 hg.repository(cmdutil.remoteui(ui, opts), dest, create=1)
 def locate(ui, repo, *pats, **opts):
 """locate files matching specific patterns
-Print files under Mercurial control in the working directory whose
+Print files under Mercurial control in the working directory whose names
-names match the given patterns.
+match the given patterns.
 By default, this command searches all directories in the working
-directory. To search just the current directory and its
+directory. To search just the current directory and its subdirectories,
-subdirectories, use "--include .".
+use "--include .".
-If no patterns are given to match, this command prints the names
+If no patterns are given to match, this command prints the names of all
-of all files under Mercurial control in the working directory.
+files under Mercurial control in the working directory.
-If you want to feed the output of this command into the "xargs"
+If you want to feed the output of this command into the "xargs" command,
-command, use the -0 option to both this command and "xargs". This
+use the -0 option to both this command and "xargs". This will avoid the
-will avoid the problem of "xargs" treating single filenames that
+problem of "xargs" treating single filenames that contain whitespace as
-contain whitespace as multiple filenames.
+multiple filenames.
 """
 end = opts.get('print0') and '\0' or '\n'
 rev = opts.get('rev') or None
 ret = 1
 return ret
 def log(ui, repo, *pats, **opts):
 """show revision history of entire repository or files
-Print the revision history of the specified files or the entire
+Print the revision history of the specified files or the entire project.
-project.
+File history is shown without following rename or copy history of files.
-File history is shown without following rename or copy history of
+Use -f/--follow with a filename to follow history across renames and
-files. Use -f/--follow with a filename to follow history across
+copies. --follow without a filename will only show ancestors or
-renames and copies. --follow without a filename will only show
+descendants of the starting revision. --follow-first only follows the
-ancestors or descendants of the starting revision. --follow-first
+first parent of merge revisions.
-only follows the first parent of merge revisions.
+If no revision range is specified, the default is tip:0 unless --follow is
-If no revision range is specified, the default is tip:0 unless
+set, in which case the working directory parent is used as the starting
---follow is set, in which case the working directory parent is
+revision.
-used as the starting revision.
 See 'hg help dates' for a list of formats valid for -d/--date.
-By default this command prints revision number and changeset id,
+By default this command prints revision number and changeset id, tags,
-tags, non-trivial parents, user, date and time, and a summary for
+non-trivial parents, user, date and time, and a summary for each commit.
-each commit. When the -v/--verbose switch is used, the list of
+When the -v/--verbose switch is used, the list of changed files and full
-changed files and full commit message are shown.
+commit message are shown.
 NOTE: log -p/--patch may generate unexpected diff output for merge
-changesets, as it will only compare the merge changeset against
+changesets, as it will only compare the merge changeset against its first
-its first parent. Also, only files different from BOTH parents
+parent. Also, only files different from BOTH parents will appear in
-will appear in files:.
+files:.
 """
 get = util.cachefunc(lambda r: repo[r].changeset())
 changeiter, matchfn = cmdutil.walkchangerevs(ui, repo, pats, get, opts)
 count += 1
 def manifest(ui, repo, node=None, rev=None):
 """output the current or given revision of the project manifest
-Print a list of version controlled files for the given revision.
+Print a list of version controlled files for the given revision. If no
-If no revision is given, the first parent of the working directory
+revision is given, the first parent of the working directory is used, or
-is used, or the null revision if no revision is checked out.
+the null revision if no revision is checked out.
 With -v, print file permissions, symlink and executable bits.
 With --debug, print file revision hashes.
 """
 ui.write("%s\n" % f)
 def merge(ui, repo, node=None, **opts):
 """merge working directory with another revision
-The current working directory is updated with all changes made in
+The current working directory is updated with all changes made in the
-the requested revision since the last common predecessor revision.
+requested revision since the last common predecessor revision.
-Files that changed between either parent are marked as changed for
+Files that changed between either parent are marked as changed for the
-the next commit and a commit must be performed before any further
+next commit and a commit must be performed before any further updates to
-updates to the repository are allowed. The next commit will have
+the repository are allowed. The next commit will have two parents.
-two parents.
+If no revision is specified, the working directory's parent is a head
-If no revision is specified, the working directory's parent is a
+revision, and the current branch contains exactly one other head, the
-head revision, and the current branch contains exactly one other
+other head is merged with by default. Otherwise, an explicit revision with
-head, the other head is merged with by default. Otherwise, an
+which to merge with must be provided.
-explicit revision with which to merge with must be provided.
 """
 if opts.get('rev') and node:
 raise util.Abort(_("please specify just one revision"))
 if not node:
 return hg.merge(repo, node, force=opts.get('force'))
 def outgoing(ui, repo, dest=None, **opts):
 """show changesets not found in destination
-Show changesets not found in the specified destination repository
+Show changesets not found in the specified destination repository or the
-or the default push location. These are the changesets that would
+default push location. These are the changesets that would be pushed if a
-be pushed if a push was requested.
+push was requested.
 See pull for valid destination format details.
 """
 limit = cmdutil.loglimit(opts)
 dest, revs, checkout = hg.parseurl(
 displayer.show(repo[n])
 def parents(ui, repo, file_=None, **opts):
 """show the parents of the working directory or revision
-Print the working directory's parent revisions. If a revision is
+Print the working directory's parent revisions. If a revision is given via
-given via -r/--rev, the parent of that revision will be printed.
+-r/--rev, the parent of that revision will be printed. If a file argument
-If a file argument is given, the revision in which the file was
+is given, the revision in which the file was last changed (before the
-last changed (before the working directory revision or the
+working directory revision or the argument to --rev if given) is printed.
-argument to --rev if given) is printed.
 """
 rev = opts.get('rev')
 if rev:
 ctx = repo[rev]
 else:
 displayer.show(repo[n])
 def paths(ui, repo, search=None):
 """show aliases for remote repositories
-Show definition of symbolic path name NAME. If no name is given,
+Show definition of symbolic path name NAME. If no name is given, show
-show definition of all available names.
+definition of all available names.
-Path names are defined in the [paths] section of /etc/mercurial/hgrc
+Path names are defined in the [paths] section of /etc/mercurial/hgrc and
-and $HOME/.hgrc. If run inside a repository, .hg/hgrc is used, too.
+$HOME/.hgrc. If run inside a repository, .hg/hgrc is used, too.
 See 'hg help urls' for more information.
 """
 if search:
 for name, path in ui.configitems("paths"):
 def pull(ui, repo, source="default", **opts):
 """pull changes from the specified source
 Pull changes from a remote repository to a local one.
-This finds all changes from the repository at the specified path
+This finds all changes from the repository at the specified path or URL
-or URL and adds them to a local repository (the current one unless
+and adds them to a local repository (the current one unless -R is
--R is specified). By default, this does not update the copy of the
+specified). By default, this does not update the copy of the project in
-project in the working directory.
+the working directory.
-Use hg incoming if you want to see what would have been added by a
+Use hg incoming if you want to see what would have been added by a pull at
-pull at the time you issued this command. If you then decide to
+the time you issued this command. If you then decide to added those
-added those changes to the repository, you should use pull -r X
+changes to the repository, you should use pull -r X where X is the last
-where X is the last changeset listed by hg incoming.
+changeset listed by hg incoming.
-If SOURCE is omitted, the 'default' path will be used.
+If SOURCE is omitted, the 'default' path will be used. See 'hg help urls'
-See 'hg help urls' for more information.
+for more information.
 """
 source, revs, checkout = hg.parseurl(ui.expandpath(source), opts.get('rev'))
 other = hg.repository(cmdutil.remoteui(repo, opts), source)
 ui.status(_('pulling from %s\n') % url.hidepassword(source))
 if revs:
 def push(ui, repo, dest=None, **opts):
 """push changes to the specified destination
 Push changes from the local repository to the given destination.
-This is the symmetrical operation for pull. It moves changes from
+This is the symmetrical operation for pull. It moves changes from the
-the current repository to a different one. If the destination is
+current repository to a different one. If the destination is local this is
-local this is identical to a pull in that directory from the
+identical to a pull in that directory from the current one.
-current one.
 By default, push will refuse to run if it detects the result would
-increase the number of remote heads. This generally indicates the
+increase the number of remote heads. This generally indicates the user
-user forgot to pull and merge before pushing.
+forgot to pull and merge before pushing.
-If -r/--rev is used, the named revision and all its ancestors will
+If -r/--rev is used, the named revision and all its ancestors will be
-be pushed to the remote repository.
+pushed to the remote repository.
-Please see 'hg help urls' for important details about ssh://
+Please see 'hg help urls' for important details about ssh:// URLs. If
-URLs. If DESTINATION is omitted, a default path will be used.
+DESTINATION is omitted, a default path will be used.
 """
 dest, revs, checkout = hg.parseurl(
 ui.expandpath(dest or 'default-push', dest or 'default'), opts.get('rev'))
 other = hg.repository(cmdutil.remoteui(repo, opts), dest)
 ui.status(_('pushing to %s\n') % url.hidepassword(dest))
 def recover(ui, repo):
 """roll back an interrupted transaction
 Recover from an interrupted commit or pull.
-This command tries to fix the repository status after an
+This command tries to fix the repository status after an interrupted
-interrupted operation. It should only be necessary when Mercurial
+operation. It should only be necessary when Mercurial suggests it.
-suggests it.
 """
 if repo.recover():
 return hg.verify(repo)
 return 1
 def remove(ui, repo, *pats, **opts):
 """remove the specified files on the next commit
 Schedule the indicated files for removal from the repository.
-This only removes files from the current branch, not from the
+This only removes files from the current branch, not from the entire
-entire project history. -A/--after can be used to remove only
+project history. -A/--after can be used to remove only files that have
-files that have already been deleted, -f/--force can be used to
+already been deleted, -f/--force can be used to force deletion, and -Af
-force deletion, and -Af can be used to remove files from the next
+can be used to remove files from the next revision without deleting them
-revision without deleting them from the working directory.
+from the working directory.
-The following table details the behavior of remove for different
+The following table details the behavior of remove for different file
-file states (columns) and option combinations (rows). The file
+states (columns) and option combinations (rows). The file states are Added
-states are Added [A], Clean [C], Modified [M] and Missing [!]
+[A], Clean [C], Modified [M] and Missing [!] (as reported by hg status).
-(as reported by hg status). The actions are Warn, Remove (from
+The actions are Warn, Remove (from branch) and Delete (from disk).
-branch) and Delete (from disk).
 A  C  M  !
 none   W  RD W  R
 -f     R  RD RD R
 -A     W  W  W  R
 -Af    R  R  R  R
-This command schedules the files to be removed at the next commit.
+This command schedules the files to be removed at the next commit. To undo
-To undo a remove before that, see hg revert.
+a remove before that, see hg revert.
 """
 after, force = opts.get('after'), opts.get('force')
 if not pats and not after:
 raise util.Abort(_('no files specified'))
 repo.remove(remove, unlink=not after)
 def rename(ui, repo, *pats, **opts):
 """rename files; equivalent of copy + remove
-Mark dest as copies of sources; mark sources for deletion. If dest
+Mark dest as copies of sources; mark sources for deletion. If dest is a
-is a directory, copies are put in that directory. If dest is a
+directory, copies are put in that directory. If dest is a file, there can
-file, there can only be one source.
+only be one source.
-By default, this command copies the contents of files as they
+By default, this command copies the contents of files as they exist in the
-exist in the working directory. If invoked with -A/--after, the
+working directory. If invoked with -A/--after, the operation is recorded,
-operation is recorded, but no copying is performed.
+but no copying is performed.
-This command takes effect at the next commit. To undo a rename
+This command takes effect at the next commit. To undo a rename before
-before that, see hg revert.
+that, see hg revert.
 """
 wlock = repo.wlock(False)
 try:
 return cmdutil.copy(ui, repo, pats, opts, rename=True)
 finally:
 def resolve(ui, repo, *pats, **opts):
 """retry file merges from a merge or update
 This command will cleanly retry unresolved file merges using file
-revisions preserved from the last update or merge. To attempt to
+revisions preserved from the last update or merge. To attempt to resolve
-resolve all unresolved files, use the -a/--all switch.
+all unresolved files, use the -a/--all switch.
-If a conflict is resolved manually, please note that the changes
+If a conflict is resolved manually, please note that the changes will be
-will be overwritten if the merge is retried with resolve. The
+overwritten if the merge is retried with resolve. The -m/--mark switch
--m/--mark switch should be used to mark the file as resolved.
+should be used to mark the file as resolved.
-This command also allows listing resolved files and manually
+This command also allows listing resolved files and manually indicating
-indicating whether or not files are resolved. All files must be
+whether or not files are resolved. All files must be marked as resolved
-marked as resolved before a commit is permitted.
+before a commit is permitted.
 The codes used to show the status of files are:
 U = unresolved
 R = resolved
 """
 util.rename(a + ".resolve", a + ".orig")
 def revert(ui, repo, *pats, **opts):
 """restore individual files or directories to an earlier state
-(Use update -r to check out earlier revisions, revert does not
+(Use update -r to check out earlier revisions, revert does not change the
-change the working directory parents.)
+working directory parents.)
-With no revision specified, revert the named files or directories
+With no revision specified, revert the named files or directories to the
-to the contents they had in the parent of the working directory.
+contents they had in the parent of the working directory. This restores
-This restores the contents of the affected files to an unmodified
+the contents of the affected files to an unmodified state and unschedules
-state and unschedules adds, removes, copies, and renames. If the
+adds, removes, copies, and renames. If the working directory has two
-working directory has two parents, you must explicitly specify the
+parents, you must explicitly specify the revision to revert to.
-revision to revert to.
+Using the -r/--rev option, revert the given files or directories to their
-Using the -r/--rev option, revert the given files or directories
+contents as of a specific revision. This can be helpful to "roll back"
-to their contents as of a specific revision. This can be helpful
+some or all of an earlier change. See 'hg help dates' for a list of
-to "roll back" some or all of an earlier change. See 'hg help
+formats valid for -d/--date.
-dates' for a list of formats valid for -d/--date.
+Revert modifies the working directory. It does not commit any changes, or
-Revert modifies the working directory. It does not commit any
+change the parent of the working directory. If you revert to a revision
-changes, or change the parent of the working directory. If you
+other than the parent of the working directory, the reverted files will
-revert to a revision other than the parent of the working
+thus appear modified afterwards.
-directory, the reverted files will thus appear modified
-afterwards.
+If a file has been deleted, it is restored. If the executable mode of a
+file was changed, it is reset.
-If a file has been deleted, it is restored. If the executable mode
-of a file was changed, it is reset.
+If names are given, all files matching the names are reverted. If no
+arguments are given, no files are reverted.
-If names are given, all files matching the names are reverted.
-If no arguments are given, no files are reverted.
+Modified files are saved with a .orig suffix before reverting. To disable
+these backups, use --no-backup.
-Modified files are saved with a .orig suffix before reverting.
-To disable these backups, use --no-backup.
 """
 if opts["date"]:
 if opts["rev"]:
 raise util.Abort(_("you can't specify a revision and a date"))
 def rollback(ui, repo):
 """roll back the last transaction
 This command should be used with care. There is only one level of
-rollback, and there is no way to undo a rollback. It will also
+rollback, and there is no way to undo a rollback. It will also restore the
-restore the dirstate at the time of the last transaction, losing
+dirstate at the time of the last transaction, losing any dirstate changes
-any dirstate changes since that time. This command does not alter
+since that time. This command does not alter the working directory.
-the working directory.
+Transactions are used to encapsulate the effects of all commands that
-Transactions are used to encapsulate the effects of all commands
+create new changesets or propagate existing changesets into a repository.
-that create new changesets or propagate existing changesets into a
+For example, the following commands are transactional, and their effects
-repository. For example, the following commands are transactional,
+can be rolled back:
-and their effects can be rolled back:
 commit
 import
 pull
 push (with this repository as destination)
 unbundle
-This command is not intended for use on public repositories. Once
+This command is not intended for use on public repositories. Once changes
-changes are visible for pull by other users, rolling a transaction
+are visible for pull by other users, rolling a transaction back locally is
-back locally is ineffective (someone else may already have pulled
+ineffective (someone else may already have pulled the changes).
-the changes). Furthermore, a race is possible with readers of the
+Furthermore, a race is possible with readers of the repository; for
-repository; for example an in-progress pull from the repository
+example an in-progress pull from the repository may fail if a rollback is
-may fail if a rollback is performed.
+performed.
 """
 repo.rollback()
 def root(ui, repo):
 """print the root (top) of the current working directory
 def serve(ui, repo, **opts):
 """export the repository via HTTP
 Start a local HTTP repository browser and pull server.
-By default, the server logs accesses to stdout and errors to
+By default, the server logs accesses to stdout and errors to stderr. Use
-stderr. Use the -A/--accesslog and -E/--errorlog options to log to
+the -A/--accesslog and -E/--errorlog options to log to files.
-files.
 """
 if opts["stdio"]:
 if repo is None:
 raise error.RepoError(_("There is no Mercurial repository here"
 cmdutil.service(opts, initfn=service.init, runfn=service.run)
 def status(ui, repo, *pats, **opts):
 """show changed files in the working directory
-Show status of files in the repository. If names are given, only
+Show status of files in the repository. If names are given, only files
-files that match are shown. Files that are clean or ignored or
+that match are shown. Files that are clean or ignored or the source of a
-the source of a copy/move operation, are not listed unless
+copy/move operation, are not listed unless -c/--clean, -i/--ignored,
--c/--clean, -i/--ignored, -C/--copies or -A/--all are given.
+-C/--copies or -A/--all are given. Unless options described with "show
-Unless options described with "show only ..." are given, the
+only ..." are given, the options -mardu are used.
-options -mardu are used.
+Option -q/--quiet hides untracked (unknown and ignored) files unless
-Option -q/--quiet hides untracked (unknown and ignored) files
+explicitly requested with -u/--unknown or -i/--ignored.
-unless explicitly requested with -u/--unknown or -i/--ignored.
+NOTE: status may appear to disagree with diff if permissions have changed
-NOTE: status may appear to disagree with diff if permissions have
+or a merge has occurred. The standard diff format does not report
-changed or a merge has occurred. The standard diff format does not
+permission changes and diff only reports changes relative to one merge
-report permission changes and diff only reports changes relative
+parent.
-to one merge parent.
+If one revision is given, it is used as the base revision. If two
-If one revision is given, it is used as the base revision.
+revisions are given, the differences between them are shown.
-If two revisions are given, the differences between them are
-shown.
 The codes used to show the status of files are:
 M = modified
 A = added
 R = removed
 def tag(ui, repo, name1, *names, **opts):
 """add one or more tags for the current or given revision
 Name a particular revision using <name>.
-Tags are used to name particular revisions of the repository and are
+Tags are used to name particular revisions of the repository and are very
-very useful to compare different revisions, to go back to significant
+useful to compare different revisions, to go back to significant earlier
-earlier versions or to mark branch points as releases, etc.
+versions or to mark branch points as releases, etc.
-If no revision is given, the parent of the working directory is
+If no revision is given, the parent of the working directory is used, or
-used, or tip if no revision is checked out.
+tip if no revision is checked out.
-To facilitate version control, distribution, and merging of tags,
+To facilitate version control, distribution, and merging of tags, they are
-they are stored as a file named ".hgtags" which is managed
+stored as a file named ".hgtags" which is managed similarly to other
-similarly to other project files and can be hand-edited if
+project files and can be hand-edited if necessary. The file
-necessary. The file '.hg/localtags' is used for local tags (not
+'.hg/localtags' is used for local tags (not shared among repositories).
-shared among repositories).
 See 'hg help dates' for a list of formats valid for -d/--date.
 """
 rev_ = "."
 repo.tag(names, r, message, opts.get('local'), opts.get('user'), date)
 def tags(ui, repo):
 """list repository tags
-This lists both regular and local tags. When the -v/--verbose
+This lists both regular and local tags. When the -v/--verbose switch is
-switch is used, a third column "local" is printed for local tags.
+used, a third column "local" is printed for local tags.
 """
 hexfunc = ui.debugflag and hex or short
 tagtype = ""
 ui.write("%s%s %s%s\n" % (t, spaces, r, tagtype))
 def tip(ui, repo, **opts):
 """show the tip revision
-The tip revision (usually just called the tip) is the changeset
+The tip revision (usually just called the tip) is the changeset most
-most recently added to the repository (and therefore the most
+recently added to the repository (and therefore the most recently changed
-recently changed head).
+head).
-If you have just made a commit, that commit will be the tip. If
+If you have just made a commit, that commit will be the tip. If you have
-you have just pulled changes from another repository, the tip of
+just pulled changes from another repository, the tip of that repository
-that repository becomes the current tip. The "tip" tag is special
+becomes the current tip. The "tip" tag is special and cannot be renamed or
-and cannot be renamed or assigned to a different changeset.
+assigned to a different changeset.
 """
 cmdutil.show_changeset(ui, repo, opts).show(repo[len(repo) - 1])
 def unbundle(ui, repo, fname1, *fnames, **opts):
 """apply one or more changegroup files
-Apply one or more compressed changegroup files generated by the
+Apply one or more compressed changegroup files generated by the bundle
-bundle command.
+command.
 """
 fnames = (fname1,) + fnames
 lock = repo.lock()
 try:
 return postincoming(ui, repo, modheads, opts.get('update'), None)
 def update(ui, repo, node=None, rev=None, clean=False, date=None, check=False):
 """update working directory
-Update the repository's working directory to the specified
+Update the repository's working directory to the specified revision, or
-revision, or the tip of the current branch if none is specified.
+the tip of the current branch if none is specified. Use null as the
-Use null as the revision to remove the working copy (like 'hg
+revision to remove the working copy (like 'hg clone -U').
-clone -U').
+When the working directory contains no uncommitted changes, it will be
-When the working directory contains no uncommitted changes, it
+replaced by the state of the requested revision from the repository. When
-will be replaced by the state of the requested revision from the
+the requested revision is on a different branch, the working directory
-repository. When the requested revision is on a different branch,
+will additionally be switched to that branch.
-the working directory will additionally be switched to that
-branch.
+When there are uncommitted changes, use option -C/--clean to discard them,
+forcibly replacing the state of the working directory with the requested
-When there are uncommitted changes, use option -C/--clean to
+revision. Alternately, use -c/--check to abort.
-discard them, forcibly replacing the state of the working
-directory with the requested revision. Alternately, use -c/--check
+When there are uncommitted changes and option -C/--clean is not used, and
-to abort.
+the parent revision and requested revision are on the same branch, and one
+of them is an ancestor of the other, then the new working directory will
-When there are uncommitted changes and option -C/--clean is not
+contain the requested revision merged with the uncommitted changes.
-used, and the parent revision and requested revision are on the
+Otherwise, the update will fail with a suggestion to use 'merge' or
-same branch, and one of them is an ancestor of the other, then the
+'update -C' instead.
-new working directory will contain the requested revision merged
-with the uncommitted changes. Otherwise, the update will fail with
+If you want to update just one file to an older revision, use revert.
-a suggestion to use 'merge' or 'update -C' instead.
-If you want to update just one file to an older revision, use
-revert.
 See 'hg help dates' for a list of formats valid for -d/--date.
 """
 if rev and node:
 raise util.Abort(_("please specify just one revision"))
 def verify(ui, repo):
 """verify the integrity of the repository
 Verify the integrity of the current repository.
-This will perform an extensive check of the repository's
+This will perform an extensive check of the repository's integrity,
-integrity, validating the hashes and checksums of each entry in
+validating the hashes and checksums of each entry in the changelog,
-the changelog, manifest, and tracked files, as well as the
+manifest, and tracked files, as well as the integrity of their crosslinks
-integrity of their crosslinks and indices.
+and indices.
 """
 return hg.verify(repo)
 def version_(ui):
 """output version and copyright information"""

Mercurial > public > mercurial-scm > hg-stable

comparison mercurial/commands.py @ 9051:f8e25885d975