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

equal deleted inserted replaced

-:14f27921932a
+:d5b1b846f277
 # 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 repository.
+Schedule files to be version controlled and added to the
+repository.
 The files will be added to the repository at the next commit. To
 undo an add before that, see hg revert.
 If no names are given, add all files to the repository.
 return rejected 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 repository.
+Add all new files and remove all missing files from the
+repository.
-New files are ignored if they match any of the patterns in .hgignore. As
-with add, these changes take effect at the next commit.
+New files are ignored if they match any of the patterns in
+.hgignore. As with add, these changes take effect at the next
+commit.
 Use the -s option to detect renamed files. With a parameter > 0,
 this compares every removed file with every added file and records
 those similar enough as renames. This option takes a percentage
 between 0 (disabled) and 100 (files must be identical) as its
 return cmdutil.addremove(repo, pats, opts, similarity=sim/100.)
 def annotate(ui, repo, *pats, **opts):
 """show changeset information per file line
-List changes in files, showing the revision id responsible for each line
+List changes in files, showing the revision id responsible for
+each line
-This command is useful to discover who did a change or when a change took
-place.
+This command is useful to discover who did a change or when a
+change took place.
 Without the -a option, annotate will avoid processing files it
 detects as binary. With -a, annotate will generate an annotation
 anyway, probably with undesirable results.
 """
 '''create unversioned archive of a repository revision
 By default, the revision used is the parent of the working
 directory; use "-r" to specify a different revision.
-To specify the type of archive to create, use "-t". Valid
+To specify the type of archive to create, use "-t". Valid types
-types are:
+are:
 "files" (default): a directory full of files
 "tar": tar archive, uncompressed
 "tbz2": tar archive, compressed using bzip2
 "tgz": tar archive, compressed using gzip
 The exact name of the destination archive or directory is given
 using a format string; see 'hg help export' for details.
 Each member added to an archive file has a directory prefix
-prepended. Use "-p" to specify a format string for the prefix.
+prepended. Use "-p" to specify a format string for the prefix. The
-The default is the basename of the archive, with suffixes removed.
+default is the basename of the archive, with suffixes removed.
 '''
 ctx = repo[opts.get('rev')]
 if not ctx:
 raise util.Abort(_('no working directory: please specify a revision'))
 created. This head will be the new tip and you should merge this
 backout changeset with another head (current one by default).
 The --merge option remembers the parent of the working directory
 before starting the backout, then merges the new head with that
-changeset afterwards. This saves you from doing the merge by
+changeset afterwards. This saves you from doing the merge by hand.
-hand. The result of this merge is not committed, as with a normal
+The result of this merge is not committed, as with a normal merge.
-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.
+This command helps to find changesets which introduce problems. To
-To use, mark the earliest changeset you know exhibits the problem
+use, mark the earliest changeset you know exhibits the problem as
-as bad, then mark the latest changeset which is free from the
+bad, then mark the latest changeset which is free from the problem
-problem as good. Bisect will update your working directory to a
+as good. Bisect will update your working directory to a revision
-revision for testing (unless the --noupdate option is specified).
+for testing (unless the --noupdate option is specified). Once you
-Once you have performed tests, mark the working directory as bad
+have performed tests, mark the working directory as bad or good
-or good and bisect will either update to another candidate changeset
+and bisect will either update to another candidate changeset or
-or announce that it has found the bad revision.
+announce that it has found the bad revision.
 As a shortcut, you can also use the revision argument to mark a
 revision as good or bad without checking it out first.
-If you supply a command it will be used for automatic bisection. Its exit
+If you supply a command it will be used for automatic bisection.
-status will be used as flag to mark revision as bad or good. In case exit
+Its exit status will be used as flag to mark revision as bad or
-status is 0 the revision is marked as good, 125 - skipped, 127 (command not
+good. In case exit status is 0 the revision is marked as good, 125
-found) - bisection will be aborted; any other status bigger than 0 will
+- skipped, 127 (command not found) - bisection will be aborted;
-mark revision as bad.
+any other status bigger than 0 will mark revision as bad.
 """
 def print_result(nodes, good):
 displayer = cmdutil.show_changeset(ui, repo, {})
 transition = (good and "good" or "bad")
 if len(nodes) == 1:
 With no argument, show the current branch name. With one argument,
 set the working directory branch name (the branch does not exist
 in the repository until the next commit). It is recommended to use
 the 'default' branch as your primary development branch.
-Unless --force is specified, branch will not let you set a
+Unless --force is specified, branch will not let you set a branch
-branch name that shadows an existing branch.
+name that shadows an existing branch.
 Use --clean to reset the working directory branch to that of the
-parent of the working directory, negating a previous branch change.
+parent of the working directory, negating a previous branch
+change.
 Use the command 'hg update' to switch to an existing branch.
 """
 if opts.get('clean'):
 assumed to have all the nodes specified by one or more --base
 parameters. To create a bundle containing all changesets, use
 --all (or --base null). To change the compression method applied,
 use the -t option (by default, bundles are compressed using bz2).
-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.
+and applied to another repository with the unbundle or pull
-This is useful when direct push and pull are not available or when
+command. This is useful when direct push and pull are not
-exporting an entire repository is undesirable.
+available or when exporting an entire repository is undesirable.
 Applying bundles preserves all changeset contents including
 permissions, copy/rename information, and revision history.
 """
 revs = opts.get('rev') or None
 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.
+Print the specified files as they were at the given revision. If
-If no revision is given, the parent of the working directory is used,
+no revision is given, the parent of the working directory is used,
 or tip if no revision is checked out.
 Output may be to a file, in which case the name of the file is
 given using a format string. The formatting rules are the same as
 for the export command, with the following additions:
 subsequent revisions (including subsequent tags) will be present
 in the cloned repository. This option implies --pull, even on
 local repositories.
 By default, clone will check out the head of the 'default' branch.
-If the -U option is used, the new clone will contain only a repository
+If the -U option is used, the new clone will contain only a
-(.hg) and no working copy (the working copy parent is the null revision).
+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.
-Look at the help text for URLs for important details about ssh:// URLs.
+Look at the help text for URLs for important details about ssh://
+URLs.
 For efficiency, hardlinks are used for cloning whenever the source
 and destination are on the same filesystem (note this applies only
 to the repository data, not to the checked out files). Some
 filesystems, such as AFS, implement hardlinking incorrectly, but
 will be committed.
 If you are committing the result of a merge, do not provide any
 file names or -I/-X filters.
-If no commit message is specified, the configured editor is started to
+If no commit message is specified, the configured editor is
-prompt you for a message.
+started to prompt you for a message.
 See 'hg help dates' for a list of formats valid for -d/--date.
 """
 extra = {}
 if opts.get('close_branch'):
 Print the changeset header and diffs for one or more revisions.
 The information shown in the changeset header is: author,
 changeset hash, parent(s) and commit comment.
-NOTE: export may generate unexpected diff output for merge changesets,
+NOTE: export may generate unexpected diff output for merge
-as it will compare the merge changeset against its first parent only.
+changesets, as it will compare the merge changeset against its
+first parent only.
 Output may be to a file, in which case the name of the file is
 given using a format string. The formatting rules are as follows:
 %%   literal "%" character
 probably with undesirable results.
 Use the --git option to generate diffs in the git extended diff
 format. Read the diffs help topic for more information.
-With the --switch-parent option, the diff will be against the second
+With the --switch-parent option, the diff will be against the
-parent. It can be useful to review a merge.
+second 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:
 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
-working directory. It always prints the revision number in which
+working directory. It always prints the revision number in which a
-a match appears.
+match appears.
 By default, grep only prints output for the first revision of a
 file in which it finds a match. To get it to print every revision
 that contains a change in match status ("-" for a match that
 becomes a non-match, or "+" for a non-match that becomes a match),
 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 and short help.
-Given a topic, extension, or command name, print help for that topic."""
+Given a topic, extension, or command name, print help for that
+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 repo.
+With no revision, print a summary of the current state of the
+repo.
 With a path, do a lookup in another repository.
-This summary identifies the repository state using one or two parent
+This summary identifies the repository state using one or two
-hash identifiers, followed by a "+" if there are uncommitted changes
+parent hash identifiers, followed by a "+" if there are
-in the working directory, a list of tags for this revision and a branch
+uncommitted changes in the working directory, a list of tags for
-name 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)"))
 text/x-patch to be used). From and Subject headers of email
 message are used as default committer and commit message. All
 text/plain body parts before first diff are added to commit
 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
+description from patch override values from message headers and
-given on command line with -m and -u override these.
+body. Values given on command line with -m and -u override these.
-If --exact is specified, import will set the working directory
+If --exact is specified, import will set the working directory to
-to the parent of each patch before applying it, and will abort
+the parent of each patch before applying it, and will abort if the
-if the resulting changeset has a different ID than the one
+resulting changeset has a different ID than the one recorded in
-recorded in the patch. This may happen due to character set
+the patch. This may happen due to character set problems or other
-problems or other deficiencies in the text patch format.
+deficiencies in the text patch format.
 With --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 patch name "-".
+To read a patch from standard input, use patch name "-". See 'hg
-See 'hg help dates' for a list of formats valid for -d/--date.
+help dates' for a list of formats valid for -d/--date.
 """
 patches = (patch1,) + patches
 date = opts.get('date')
 if date:
 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
-pull location. These are the changesets that would be pulled if a pull
+pull location. These are the changesets that would be pulled if a
-was requested.
+pull was requested.
-For remote repository, using --bundle avoids downloading the changesets
+For remote repository, using --bundle avoids downloading the
-twice if the incoming is followed by a pull.
+changesets 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'))
 Print a list of version controlled files for the given revision.
 If no revision is given, the first parent of the working directory
 is used, or tip if no revision is checked out.
-With -v flag, print file permissions, symlink and executable bits. With
+With -v flag, print file permissions, symlink and executable bits.
---debug flag, print file revision hashes.
+With --debug flag, print file revision hashes.
 """
 if rev and node:
 raise util.Abort(_("please specify just one revision"))
 Files that changed between either parent are marked as changed for
 the next commit and a commit must be performed before any further
 updates are allowed. The next commit has two parents.
 If no revision is specified, the working directory's parent is a
-head revision, and the current branch contains exactly one other head,
+head revision, and the current branch contains exactly one other
-the other head is merged with by default. Otherwise, an explicit
+head, the other head is merged with by default. Otherwise, an
-revision to merge with must be provided.
+explicit revision to merge with must be provided.
 """
 if rev and node:
 raise util.Abort(_("please specify just one revision"))
 if not node:
 return hg.merge(repo, node, force=force)
 def outgoing(ui, repo, dest=None, **opts):
 """show changesets not found in destination
-Show changesets not found in the specified destination repository or
+Show changesets not found in the specified destination repository
-the default push location. These are the changesets that would be pushed
+or the default push location. These are the changesets that would
-if a push was requested.
+be pushed if a 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 dir or revision
-Print the working directory's parent revisions. If a
+Print the working directory's parent revisions. If a revision is
-revision is given via --rev, the parent of that revision
+given via --rev, the parent of that revision will be printed. If a
-will be printed. If a file argument is given, revision in
+file argument is given, revision in which the file was last
-which the file was last changed (before the working directory
+changed (before the working directory revision or the argument to
-revision or the argument to --rev if given) is printed.
+--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
+Show definition of symbolic path name NAME. If no name is given,
-definition of available names.
+show definition of available names.
 Path names are defined in the [paths] section of /etc/mercurial/hgrc
 and $HOME/.hgrc. If run inside a repository, .hg/hgrc is used, too.
 See 'hg help urls' for more information.
 the client has forgotten to pull and merge before pushing.
 If -r is used, the named revision and all its ancestors will be
 pushed to the remote repository.
-Look at the help text for URLs for important details about ssh:// URLs.
+Look at the help text for URLs for important details about ssh://
-If DESTINATION is omitted, a default path will be used.
+URLs. If DESTINATION is omitted, a default path will be used.
 See 'hg help urls' for more information.
 """
 dest, revs, checkout = hg.parseurl(
 ui.expandpath(dest or 'default-push', dest or 'default'), opts.get('rev'))
 cmdutil.setremoteconfig(ui, opts)
 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 interrupted
+This command tries to fix the repository status after an
-operation. It should only be necessary when Mercurial suggests it.
+interrupted operation. It should only be necessary when Mercurial
+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 entire
+This only removes files from the current branch, not from the
-project history. -A can be used to remove only files that have already
+entire project history. -A can be used to remove only files that
-been deleted, -f can be used to force deletion, and -Af can be used
+have already been deleted, -f can be used to force deletion, and
-to remove files from the next revision without deleting them.
+-Af can be used to remove files from the next revision without
+deleting them.
-The following table details the behavior of remove for different file
-states (columns) and option combinations (rows). The file states are
+The following table details the behavior of remove for different
-Added, Clean, Modified and Missing (as reported by hg status). The
+file states (columns) and option combinations (rows). The file
-actions are Warn, Remove (from branch) and Delete (from disk).
+states are Added, Clean, Modified and Missing (as reported by hg
+status). The actions are Warn, Remove (from branch) and Delete
+(from disk).
 A  C  M  !
 none   W  RD W  R
 -f     R  RD RD R
 -A     W  W  W  R
 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
+Mark dest as copies of sources; mark sources for deletion. If dest
-dest is a directory, copies are put in that directory. If dest is
+is a directory, copies are put in that directory. If dest is a
-a file, there can only be one source.
+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 --after, the
 operation is recorded, but no copying is performed.
 This restores the contents of the affected files to an unmodified
 state and unschedules adds, removes, copies, and renames. If the
 working directory has two parents, you must explicitly specify the
 revision to revert to.
-Using the -r option, revert the given files or directories to their
+Using the -r option, revert the given files or directories to
-contents as of a specific revision. This can be helpful to "roll
+their contents as of a specific revision. This can be helpful to
-back" some or all of an earlier change.
+"roll back" some or all of an earlier change. See 'hg help dates'
-See 'hg help dates' for a list of formats valid for -d/--date.
+for a list of formats valid for -d/--date.
 Revert modifies the working directory. It does not commit any
 changes, or change the parent of the working directory. If you
 revert to a revision other than the parent of the working
 directory, the reverted files will thus appear modified
 afterwards.
-If a file has been deleted, it is restored. If the executable
+If a file has been deleted, it is restored. If the executable mode
-mode of a file was changed, it is reset.
+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.
 Modified files are saved with a .orig suffix before reverting.
 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.
-If no revision is given, the parent of the working directory is used,
+If no revision is given, the parent of the working directory is
-or tip if no revision is checked out.
+used, or tip if no revision is checked out.
 To facilitate version control, distribution, and merging of tags,
 they are stored as a file named ".hgtags" which is managed
 similarly to other project files and can be hand-edited if
 necessary. The file '.hg/localtags' is used for local tags (not
 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 switch
+This lists both regular and local tags. When the -v/--verbose
-is used, a third column "local" is printed for local tags.
+switch is used, a third column "local" is printed for local tags.
 """
 l = repo.tagslist()
 l.reverse()
 hexfunc = ui.debugflag and hex or short
 return postincoming(ui, repo, modheads, opts.get('update'), None)
 def update(ui, repo, node=None, rev=None, clean=False, date=None):
 """update working directory
-Update the repository's working directory to the specified revision,
+Update the repository's working directory to the specified
-or the tip of the current branch if none is specified. Use null as
+revision, or the tip of the current branch if none is specified.
-the revision to remove the working copy (like 'hg clone -U').
+Use null as the revision to remove the working copy (like 'hg
+clone -U').
 When the working dir contains no uncommitted changes, it will be
-replaced by the state of the requested revision from the repo. When
+replaced by the state of the requested revision from the repo.
-the requested revision is on a different branch, the working dir
+When the requested revision is on a different branch, the working
-will additionally be switched to that branch.
+dir will additionally be switched to that branch.
 When there are uncommitted changes, use option -C to discard them,
 forcibly replacing the state of the working dir with the requested
 revision.
 and one of them is an ancestor of the other, then the new working
 directory will contain the requested revision merged with the
 uncommitted changes. Otherwise, the update will fail with a
 suggestion to use 'merge' or 'update -C' instead.
-If you want to update just one file to an older revision, use revert.
+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 --date.
 """
 if rev and node:
 raise util.Abort(_("please specify just one revision"))

changeset 8004	d5b1b846f277
parent 7983	7b813bdbd5d0
child 8007	a4defdc4f5dc