hg/pyhgsh: mercurial/commands.py comparison

comparison mercurial/commands.py @ 1437:ea51d296085f

import docstring from doc/hg.1.txt

author	Benoit Boissinot <benoit.boissinot@ens-lyon.org>
date	Mon, 24 Oct 2005 15:52:28 -0700
parents	db6d7b4005ba
children	65cbe22b03fa

comparison

equal deleted inserted replaced

-:db6d7b4005ba
+:ea51d296085f
 ui.write("%s\n" % first)
 # Commands start here, listed alphabetically
 def add(ui, repo, *pats, **opts):
-'''add the specified files on the next commit'''
+"""add the specified files on the next commit
+Schedule files to be version controlled and added to the repository.
+The files will be added to the repository at the next commit.
+If no names are given, add all files in the current directory and
+its subdirectories.
+"""
 names = []
 for src, abs, rel, exact in walk(repo, pats, opts):
 if exact:
 if ui.verbose: ui.status(_('adding %s\n') % rel)
 names.append(abs)
 ui.status(_('adding %s\n') % rel)
 names.append(abs)
 repo.add(names)
 def addremove(ui, repo, *pats, **opts):
-"""add all new files, delete all missing files"""
+"""add all new files, delete all missing files
+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.
+"""
 add, remove = [], []
 for src, abs, rel, exact in walk(repo, pats, opts):
 if src == 'f' and repo.dirstate.state(abs) == '?':
 add.append(abs)
 if ui.verbose or not exact:
 ui.status(_('removing %s\n') % rel)
 repo.add(add)
 repo.remove(remove)
 def annotate(ui, repo, *pats, **opts):
-"""show changeset information per file line"""
+"""show changeset information per file 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.
+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.
+"""
 def getnode(rev):
 return short(repo.changelog.node(rev))
 ucache = {}
 def getname(rev):
 if pieces:
 for p, l in zip(zip(*pieces), lines):
 ui.write("%s: %s" % (" ".join(p), l[1]))
 def bundle(ui, repo, fname, dest="default-push", **opts):
-"""create a changegroup file"""
+"""create a changegroup file
+Generate a compressed changegroup file collecting all changesets
+not found in the other repository.
+This file can then be transferred using conventional means and
+applied to another repository with the unbundle command. This is
+useful when native push and pull are not available or when
+exporting an entire repository is undesirable. The standard file
+extension is ".hg".
+Unlike import/export, this exactly preserves all changeset
+contents including permissions, rename data, and revision history.
+"""
 f = open(fname, "wb")
 dest = ui.expandpath(dest)
 other = hg.repository(ui, dest)
 o = repo.findoutgoing(other)
 cg = repo.changegroup(o)
 except:
 os.unlink(fname)
 raise
 def cat(ui, repo, file1, *pats, **opts):
-"""output the latest or given revisions of files"""
+"""output the latest or given revisions of files
+Print the specified files as they were at the given revision.
+If no revision is given then the tip is used.
+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:
+%s   basename of file being printed
+%d   dirname of file being printed, or '.' if in repo root
+%p   root-relative path name of file being printed
+"""
 mf = {}
 if opts['rev']:
 change = repo.changelog.read(repo.lookup(opts['rev']))
 mf = repo.manifest.read(change[0])
 for src, abs, rel, exact in walk(repo, (file1,) + pats, opts):
 n = r.tip()
 fp = make_file(repo, r, opts['output'], node=n, pathname=abs)
 fp.write(r.read(n))
 def clone(ui, source, dest=None, **opts):
-"""make a copy of an existing repository"""
+"""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
+basename of the source.
+The location of the source is added to the new repository's
+.hg/hgrc file, as the default to be used for future pulls.
+For efficiency, hardlinks are used for cloning whenever the source
+and destination are on the same filesystem.  Some filesystems,
+such as AFS, implement hardlinking incorrectly, but do not report
+errors.  In these cases, use the --pull option to avoid
+hardlinking.
+"""
 if dest is None:
 dest = os.path.basename(os.path.normpath(source))
 if os.path.exists(dest):
 raise util.Abort(_("destination '%s' already exists"), dest)
 update(ui, repo)
 d.close()
 def commit(ui, repo, *pats, **opts):
-"""commit the specified files or all outstanding changes"""
+"""commit the specified files or all outstanding changes
+Commit changes to the given files into the repository.
+If a list of files is omitted, all changes reported by "hg status"
+from the root of the repository will be commited.
+The HGEDITOR or EDITOR environment variables are used to start an
+editor to add a commit comment.
+"""
 if opts['text']:
 ui.warn(_("Warning: -t and --text is deprecated,"
 " please use -m or --message instead.\n"))
 message = opts['message'] or opts['text']
 logfile = opts['logfile']
 if errs:
 ui.warn(_('(consider using --after)\n'))
 return errs, copied
 def copy(ui, repo, *pats, **opts):
-"""mark files as copied for the next commit"""
+"""mark files as copied for the next commit
+Mark dest as having copies of source files.  If dest is a
+directory, copies are put in that directory.  If dest is a file,
+there can only be one source.
+By default, this command copies the contents of files as they
+stand in the working directory.  If invoked with --after, the
+operation is recorded, but no copying is performed.
+This command takes effect in the next commit.
+NOTE: This command should be treated as experimental. While it
+should properly record copied files, this information is not yet
+fully used by merge, nor fully reported by log.
+"""
 errs, copied = docopy(ui, repo, pats, opts)
 return errs
 def debugancestor(ui, index, rev1, rev2):
 """find the ancestor revision of two revisions in a given index"""
 for src, abs, rel, exact in items:
 line = fmt % (src, abs, rel, exact and 'exact' or '')
 ui.write("%s\n" % line.rstrip())
 def diff(ui, repo, *pats, **opts):
-"""diff working directory (or selected files)"""
+"""diff working directory (or selected files)
+Show differences between revisions for the specified files.
+Differences between files are shown using the unified diff format.
+When two revision arguments are given, then changes are shown
+between those revisions. If only one revision is specified then
+that revision is compared to the working directory, and, when no
+revisions are specified, the working directory files are compared
+to its parent.
+Without the -a option, diff will avoid generating diffs of files
+it detects as binary. With -a, diff will generate a diff anyway,
+probably with undesirable results.
+"""
 node1, node2 = None, None
 revs = [repo.lookup(x) for x in opts['rev']]
 if len(revs) > 0:
 node1 = revs[0]
 dodiff(fp, ui, repo, prev, node, text=opts['text'])
 if fp != sys.stdout:
 fp.close()
 def export(ui, repo, *changesets, **opts):
-"""dump the header and diffs for one or more changesets"""
+"""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,
+changeset hash, parent and commit comment.
+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
+%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 option, export will avoid generating diffs of files
+it detects as binary. With -a, export will generate a diff anyway,
+probably with undesirable results.
+"""
 if not changesets:
 raise util.Abort(_("export requires at least one changeset"))
 seqno = 0
 revs = list(revrange(ui, repo, changesets))
 total = len(revs)
 for cset in revs:
 seqno += 1
 doexport(ui, repo, cset, seqno, total, revwidth, opts)
 def forget(ui, repo, *pats, **opts):
-"""don't add the specified files on the next commit"""
+"""don't add the specified files on the next commit
+Undo an 'hg add' scheduled for the next commit.
+"""
 forget = []
 for src, abs, rel, exact in walk(repo, pats, opts):
 if repo.dirstate.state(abs) == 'a':
 forget.append(abs)
 if ui.verbose or not exact:
 ui.status(_('forgetting %s\n') % rel)
 repo.forget(forget)
 def grep(ui, repo, pattern, *pats, **opts):
-"""search for a pattern in specified files and revisions"""
+"""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
+working directory.  It always prints the revision number in which
+a 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),
+use the --all flag.
+"""
 reflags = 0
 if opts['ignore_case']:
 reflags |= re.I
 regexp = re.compile(pattern, reflags)
 sep, eol = ':', '\n'
 if fn in skip: continue
 display(fn, rev, {}, state)
 return (count == 0 and 1) or 0
 def heads(ui, repo, **opts):
-"""show current repository heads"""
+"""show current repository heads
+Show all repository head changesets.
+Repository "heads" are changesets that don't have children
+changesets. They are where development generally takes place and
+are the usual targets for update and merge operations.
+"""
 heads = repo.changelog.heads()
 br = None
 if opts['branches']:
 br = repo.branchlookup(heads)
 for n in repo.changelog.heads():
 show_changeset(ui, repo, changenode=n, brinfo=br)
 def identify(ui, repo):
-"""print information about the working copy"""
+"""print information about the working copy
+Print a short summary of the current state of the repo.
+This summary identifies the repository state using one or two parent
+hash identifiers, followed by a "+" if there are uncommitted changes
+in the working directory, followed by a list of tags for this revision.
+"""
 parents = [p for p in repo.dirstate.parents() if p != nullid]
 if not parents:
 ui.write(_("unknown\n"))
 return
 output.append(' + '.join(parenttags))
 ui.write("%s\n" % ' '.join(output))
 def import_(ui, repo, patch1, *patches, **opts):
-"""import an ordered set of patches"""
+"""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
+will abort unless given the -f flag.
+If a patch looks like a mail message (its first line starts with
+"From " or looks like an RFC822 header), it will not be applied
+unless the -f option is used.  The importer neither parses nor
+discards mail headers, so use -f only to override the "mailness"
+safety check, not to import a real mail message.
+"""
 patches = (patch1,) + patches
 if not opts['force']:
 (c, a, d, u) = repo.changes()
 if c or a or d:
 if len(files) > 0:
 addremove(ui, repo, *files)
 repo.commit(files, message, user)
 def incoming(ui, repo, source="default", **opts):
-"""show new changesets found in source"""
+"""show new changesets found in source
+Show new changesets found in the specified repo or the default
+pull repo. These are the changesets that would be pulled if a pull
+was requested.
+Currently only local repositories are supported.
+"""
 source = ui.expandpath(source)
 other = hg.repository(ui, source)
 if not other.local():
 raise util.Abort(_("incoming doesn't work for remote repositories yet"))
 o = repo.findincoming(other)
 prev = (parents and parents[0]) or nullid
 dodiff(ui, ui, other, prev, n)
 ui.write("\n")
 def init(ui, dest="."):
-"""create a new repository in the given directory"""
+"""create a new repository in the given directory
+Initialize a new repository in the given directory.  If the given
+directory does not exist, it is created.
+If no directory is given, the current directory is used.
+"""
 if not os.path.exists(dest):
 os.mkdir(dest)
 hg.repository(ui, dest, create=1)
 def locate(ui, repo, *pats, **opts):
-"""locate files matching specific patterns"""
+"""locate files matching specific patterns
+Print all files under Mercurial control whose names match the
+given patterns.
+This command searches the current directory and its
+subdirectories.  To search an entire repository, move to the root
+of the repository.
+If no patterns are given to match, this command prints all file
+names.
+If you want to feed the output of this command into the "xargs"
+command, use the "-0" option to both this command and "xargs".
+This will avoid the problem of "xargs" treating single filenames
+that contain white space as multiple filenames.
+"""
 end = opts['print0'] and '\0' or '\n'
 for src, abs, rel, exact in walk(repo, pats, opts, '(?:.*/|)'):
 if repo.dirstate.state(abs) == '?':
 continue
 ui.write(os.path.join(repo.root, abs), end)
 else:
 ui.write(rel, end)
 def log(ui, repo, *pats, **opts):
-"""show revision history of entire repository or files"""
+"""show revision history of entire repository or files
+Print the revision history of the specified files or the entire project.
+By default this command outputs: changeset id and hash, tags,
+parents, user, date and time, and a summary for each commit. The
+-v switch adds some more detail, such as changed files, manifest
+hashes or message signatures.
+"""
 class dui:
 # Implement and delegate some ui protocol.  Save hunks of
 # output for later display in the desired order.
 def __init__(self, ui):
 self.ui = ui
 elif st == 'iter':
 for args in du.hunk[rev]:
 ui.write(*args)
 def manifest(ui, repo, rev=None):
-"""output the latest or given revision of the project manifest"""
+"""output the latest or given revision of the project manifest
+Print a list of version controlled files for the given revision.
+The manifest is the list of files being version controlled. If no revision
+is given then the tip is used.
+"""
 if rev:
 try:
 # assume all revision numbers are for changesets
 n = repo.lookup(rev)
 change = repo.changelog.read(n)
 for f in files:
 ui.write("%40s %3s %s\n" % (hex(m[f]), mf[f] and "755" or "644", f))
 def outgoing(ui, repo, dest="default-push", **opts):
-"""show changesets not found in destination"""
+"""show changesets not found in destination
+Show changesets not found in the specified destination repo or the
+default push repo. These are the changesets that would be pushed
+if a push was requested.
+"""
 dest = ui.expandpath(dest)
 other = hg.repository(ui, dest)
 o = repo.findoutgoing(other)
 o = repo.newer(o)
 for n in o:
 prev = (parents and parents[0]) or nullid
 dodiff(ui, ui, repo, prev, n)
 ui.write("\n")
 def parents(ui, repo, rev=None):
-"""show the parents of the working dir or revision"""
+"""show the parents of the working dir or revision
+Print the working directory's parent revisions.
+"""
 if rev:
 p = repo.changelog.parents(repo.lookup(rev))
 else:
 p = repo.dirstate.parents()
 for n in p:
 if n != nullid:
 show_changeset(ui, repo, changenode=n)
 def paths(ui, search=None):
-"""show definition of symbolic path names"""
+"""show definition of symbolic path names
+Show definition of symbolic path name NAME. If no name is given, 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.
+"""
 try:
 repo = hg.repository(ui=ui)
 except hg.RepoError:
 pass
 else:
 for name, path in ui.configitems("paths"):
 ui.write("%s = %s\n" % (name, path))
 def pull(ui, repo, source="default", **opts):
-"""pull changes from the specified source"""
+"""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
+or URL and adds them to the local repository. By default, this
+does not update the copy of the project in the working directory.
+Valid URLs are of the form:
+local/filesystem/path
+http://[user@]host[:port][/path]
+https://[user@]host[:port][/path]
+ssh://[user@]host[:port][/path]
+SSH requires an accessible shell account on the destination machine
+and a copy of hg in the remote path.  With SSH, paths are relative
+to the remote user's home directory by default; use two slashes at
+the start of a path to specify it as relative to the filesystem root.
+"""
 source = ui.expandpath(source)
 ui.status(_('pulling from %s\n') % (source))
 if opts['ssh']:
 ui.setconfig("ui", "ssh", opts['ssh'])
 ui.status(_("(run 'hg update' to get a working copy)\n"))
 return r
 def push(ui, repo, dest="default-push", force=False, ssh=None, remotecmd=None):
-"""push changes to the specified destination"""
+"""push changes to the specified destination
+Push changes from the local repository to the given destination.
+This is the symmetrical operation for pull. It helps to move
+changes from the current repository to a different one. If the
+destination is local this is identical to a pull in that directory
+from the 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
+the client has forgotten to sync and merge before pushing.
+Valid URLs are of the form:
+local/filesystem/path
+ssh://[user@]host[:port][/path]
+SSH requires an accessible shell account on the destination
+machine and a copy of hg in the remote path.
+"""
 dest = ui.expandpath(dest)
 ui.status('pushing to %s\n' % (dest))
 if ssh:
 ui.setconfig("ui", "ssh", ssh)
 other = hg.repository(ui, dest)
 r = repo.push(other, force)
 return r
 def rawcommit(ui, repo, *flist, **rc):
-"raw commit interface"
+"""raw commit interface
+Lowlevel commit, for use in helper scripts.
+This command is not intended to be used by normal users, as it is
+primarily useful for importing from other SCMs.
+"""
 if rc['text']:
 ui.warn(_("Warning: -t and --text is deprecated,"
 " please use -m or --message instead.\n"))
 message = rc['message'] or rc['text']
 if not message and rc['logfile']:
 repo.rawcommit(files, message, rc['user'], rc['date'], *rc['parent'])
 except ValueError, inst:
 raise util.Abort(str(inst))
 def recover(ui, repo):
-"""roll back an interrupted transaction"""
+"""roll back an interrupted transaction
+Recover from an interrupted commit or pull.
+This command tries to fix the repository status after an interrupted
+operation. It should only be necessary when Mercurial suggests it.
+"""
 repo.recover()
 def remove(ui, repo, pat, *pats, **opts):
-"""remove the specified files on the next commit"""
+"""remove the specified files on the next commit
+Schedule the indicated files for removal from the repository.
+This command schedules the files to be removed at the next commit.
+This only removes files from the current branch, not from the
+entire project history.  If the files still exist in the working
+directory, they will be deleted from it.
+"""
 names = []
 def okaytoremove(abs, rel, exact):
 c, a, d, u = repo.changes(files = [abs])
 reason = None
 if c: reason = _('is modified')
 if ui.verbose or not exact: ui.status(_('removing %s\n') % rel)
 names.append(abs)
 repo.remove(names, unlink=True)
 def rename(ui, repo, *pats, **opts):
-"""rename files; equivalent of copy + remove"""
+"""rename files; equivalent of copy + remove
+Mark dest as copies of sources; mark sources for deletion.  If
+dest is a directory, copies are put in that directory.  If dest is
+a file, there can only be one source.
+By default, this command copies the contents of files as they
+stand in the working directory.  If invoked with --after, the
+operation is recorded, but no copying is performed.
+This command takes effect in the next commit.
+NOTE: This command should be treated as experimental. While it
+should properly record rename files, this information is not yet
+fully used by merge, nor fully reported by log.
+"""
 errs, copied = docopy(ui, repo, pats, opts)
 names = []
 for abs, rel, exact in copied:
 if ui.verbose or not exact: ui.status(_('removing %s\n') % rel)
 names.append(abs)
 repo.remove(names, unlink=True)
 return errs
 def revert(ui, repo, *names, **opts):
-"""revert modified files or dirs back to their unmodified states"""
+"""revert modified files or dirs back to their unmodified states
+Revert any uncommitted modifications made to the named files or
+directories.  This restores the contents of the affected files to
+an unmodified state.
+If a file has been deleted, it is recreated.  If the executable
+mode of a file was changed, it is reset.
+If a directory is given, all files in that directory and its
+subdirectories are reverted.
+If no arguments are given, all files in the current directory and
+its subdirectories are reverted.
+"""
 node = opts['rev'] and repo.lookup(opts['rev']) or \
 repo.dirstate.parents()[0]
 root = os.path.realpath(repo.root)
 def trimpath(p):
 r = 1
 sys.stdout.flush()
 return r
 def root(ui, repo):
-"""print the root (top) of the current working dir"""
+"""print the root (top) of the current working dir
+Print the root directory of the current repository.
+"""
 ui.write(repo.root + "\n")
 def serve(ui, repo, **opts):
-"""export the repository via HTTP"""
+"""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
+stderr.  Use the "-A" and "-E" options to log to files.
+"""
 if opts["stdio"]:
 fin, fout = sys.stdin, sys.stdout
 sys.stdout = sys.stderr
 else:
 ui.status(_('listening at http://%s/\n') % addr)
 httpd.serve_forever()
 def status(ui, repo, *pats, **opts):
-'''show changed files in the working directory
+"""show changed files in the working directory
+Show changed files in the working directory.  If no names are
+given, all files are shown.  Otherwise, only files matching the
+given names are shown.
+The codes used to show the status of files are:
 M = modified
 A = added
 R = removed
 ? = not tracked
-'''
+"""
 cwd = repo.getcwd()
 files, matchfn, anypats = matchpats(repo, cwd, pats, opts)
 (c, a, d, u) = [[util.pathto(cwd, x) for x in n]
 for n in repo.changes(files=files, match=matchfn)]
 for f in changes:
 ui.write(format % f)
 def tag(ui, repo, name, rev=None, **opts):
-"""add a tag for the current tip or a given revision"""
+"""add a tag for the current tip or a given revision
+Name a particular revision using <name>.
+Tags are used to name particular revisions of the repository and are
+very useful to compare different revision, to go back to significant
+earlier versions or to mark branch points as releases, etc.
+If no revision is given, the tip is used.
+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.
+"""
 if opts['text']:
 ui.warn(_("Warning: -t and --text is deprecated,"
 " please use -m or --message instead.\n"))
 if name == "tip":
 raise util.Abort(_("the name 'tip' is reserved"))
 repo.commit([".hgtags"], message, opts['user'], opts['date'])
 except ValueError, inst:
 raise util.Abort(str(inst))
 def tags(ui, repo):
-"""list repository tags"""
+"""list repository tags
+List the repository tags.
+This lists both regular and local tags.
+"""
 l = repo.tagslist()
 l.reverse()
 for t, n in l:
 try:
 except KeyError:
 r = "    ?:?"
 ui.write("%-30s %s\n" % (t, r))
 def tip(ui, repo):
-"""show the tip revision"""
+"""show the tip revision
+Show the tip revision.
+"""
 n = repo.changelog.tip()
 show_changeset(ui, repo, changenode=n)
 def unbundle(ui, repo, fname):
-"""apply a changegroup file"""
+"""apply a changegroup file
+Apply a compressed changegroup file generated by the bundle
+command.
+"""
 f = urllib.urlopen(fname)
 if f.read(4) != "HG10":
 raise util.Abort(_("%s: not a Mercurial bundle file") % fname)
 ineffective.
 """
 repo.undo()
 def update(ui, repo, node=None, merge=False, clean=False, branch=None):
-'''update or merge working directory
+"""update or merge working directory
+Update the working directory to the specified revision.
 If there are no outstanding changes in the working directory and
 there is a linear relationship between the current version and the
 requested version, the result is the requested version.
 Otherwise the result is a merge between the contents of the
 current working directory and the requested version. 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.
-'''
+By default, update will refuse to run if doing so would require
+merging or discarding local changes.
+"""
 if branch:
 br = repo.branchlookup(branch=branch)
 found = []
 for x in br:
 if branch in br[x]:
 else:
 node = node and repo.lookup(node) or repo.changelog.tip()
 return repo.update(node, allow=merge, force=clean)
 def verify(ui, repo):
-"""verify the integrity of the repository"""
+"""verify the integrity of the repository
+Verify the integrity of the current repository.
+This will perform an extensive check of the repository's
+integrity, validating the hashes and checksums of each entry in
+the changelog, manifest, and tracked files, as well as the
+integrity of their crosslinks and indices.
+"""
 return repo.verify()
 # Command options and aliases are listed here, alphabetically
 table = {
 "^add":
 (add,
-[('I', 'include', [], _('include path in search')),
+[('I', 'include', [], _('include names matching the given patterns')),
-('X', 'exclude', [], _('exclude path from search'))],
+('X', 'exclude', [], _('exclude names matching the given patterns'))],
 "hg add [OPTION]... [FILE]..."),
 "addremove":
 (addremove,
-[('I', 'include', [], _('include path in search')),
+[('I', 'include', [], _('include names matching the given patterns')),
-('X', 'exclude', [], _('exclude path from search'))],
+('X', 'exclude', [], _('exclude names matching the given patterns'))],
-_("hg addremove [OPTION]... [FILE]...")),
+"hg addremove [OPTION]... [FILE]..."),
 "^annotate":
 (annotate,
-[('r', 'rev', '', _('revision')),
+[('r', 'rev', '', _('annotate the specified revision')),
 ('a', 'text', None, _('treat all files as text')),
-('u', 'user', None, _('show user')),
+('u', 'user', None, _('list the author')),
-('n', 'number', None, _('show revision number')),
+('n', 'number', None, _('list the revision number (default)')),
-('c', 'changeset', None, _('show changeset')),
+('c', 'changeset', None, _('list the changeset')),
-('I', 'include', [], _('include path in search')),
+('I', 'include', [], _('include names matching the given patterns')),
-('X', 'exclude', [], _('exclude path from search'))],
+('X', 'exclude', [], _('exclude names matching the given patterns'))],
 _('hg annotate [OPTION]... FILE...')),
 "bundle":
 (bundle,
 [],
 _('hg bundle FILE DEST')),
 "cat":
 (cat,
-[('I', 'include', [], _('include path in search')),
+[('I', 'include', [], _('include names matching the given patterns')),
-('X', 'exclude', [], _('exclude path from search')),
+('X', 'exclude', [], _('exclude names matching the given patterns')),
-('o', 'output', "", _('output to file')),
+('o', 'output', "", _('print output to file with formatted name')),
-('r', 'rev', '', _('revision'))],
+('r', 'rev', '', _('print the given revision'))],
 _('hg cat [OPTION]... FILE...')),
 "^clone":
 (clone,
-[('U', 'noupdate', None, _('skip update after cloning')),
+[('U', 'noupdate', None, _('do not update the new working directory')),
-('e', 'ssh', "", _('ssh command')),
+('e', 'ssh', "", _('specify ssh command to use')),
 ('', 'pull', None, _('use pull protocol to copy metadata')),
-('', 'remotecmd', "", _('remote hg command'))],
+('', 'remotecmd', "", _('specify hg command to run on the remote side'))],
 _('hg clone [OPTION]... SOURCE [DEST]')),
 "^commit|ci":
 (commit,
-[('A', 'addremove', None, _('run add/remove during commit')),
+[('A', 'addremove', None, _('run addremove during commit')),
-('I', 'include', [], _('include path in search')),
+('I', 'include', [], _('include names matching the given patterns')),
-('X', 'exclude', [], _('exclude path from search')),
+('X', 'exclude', [], _('exclude names matching the given patterns')),
-('m', 'message', "", _('commit message')),
+('m', 'message', "", _('use <text> as commit message')),
 ('t', 'text', "", _('commit message (deprecated: use -m)')),
-('l', 'logfile', "", _('commit message file')),
+('l', 'logfile', "", _('read the commit message from <file>')),
-('d', 'date', "", _('date code')),
+('d', 'date', "", _('record datecode as commit date')),
-('u', 'user', "", _('user'))],
+('u', 'user', "", _('record user as commiter'))],
 _('hg commit [OPTION]... [FILE]...')),
 "copy|cp": (copy,
-[('I', 'include', [], _('include path in search')),
+[('I', 'include', [], _('include names matching the given patterns')),
-('X', 'exclude', [], _('exclude path from search')),
+('X', 'exclude', [], _('exclude names matching the given patterns')),
-('A', 'after', None, _('record a copy after it has happened')),
+('A', 'after', None, _('record a copy that has already occurred')),
-('f', 'force', None, _('replace destination if it exists')),
+('f', 'force', None, _('forcibly copy over an existing managed file')),
 ('p', 'parents', None, _('append source path to dest'))],
 _('hg copy [OPTION]... [SOURCE]... DEST')),
 "debugancestor": (debugancestor, [], _('debugancestor INDEX REV1 REV2')),
 "debugcheckstate": (debugcheckstate, [], _('debugcheckstate')),
 "debugconfig": (debugconfig, [], _('debugconfig')),
 "debugindex": (debugindex, [], _('debugindex FILE')),
 "debugindexdot": (debugindexdot, [], _('debugindexdot FILE')),
 "debugrename": (debugrename, [], _('debugrename FILE [REV]')),
 "debugwalk":
 (debugwalk,
-[('I', 'include', [], _('include path in search')),
+[('I', 'include', [], _('include names matching the given patterns')),
-('X', 'exclude', [], _('exclude path from search'))],
+('X', 'exclude', [], _('exclude names matching the given patterns'))],
 _('debugwalk [OPTION]... [FILE]...')),
 "^diff":
 (diff,
 [('r', 'rev', [], _('revision')),
 ('a', 'text', None, _('treat all files as text')),
-('I', 'include', [], _('include path in search')),
+('I', 'include', [], _('include names matching the given patterns')),
-('X', 'exclude', [], _('exclude path from search'))],
+('X', 'exclude', [], _('exclude names matching the given patterns'))],
 _('hg diff [-a] [-I] [-X] [-r REV1 [-r REV2]] [FILE]...')),
 "^export":
 (export,
-[('o', 'output', "", _('output to file')),
+[('o', 'output', "", _('print output to file with formatted name')),
 ('a', 'text', None, _('treat all files as text'))],
-_("hg export [-a] [-o OUTFILE] REV...")),
+"hg export [-a] [-o OUTFILE] REV..."),
 "forget":
 (forget,
-[('I', 'include', [], _('include path in search')),
+[('I', 'include', [], _('include names matching the given patterns')),
-('X', 'exclude', [], _('exclude path from search'))],
+('X', 'exclude', [], _('exclude names matching the given patterns'))],
-_("hg forget [OPTION]... FILE...")),
+"hg forget [OPTION]... FILE..."),
 "grep":
 (grep,
 [('0', 'print0', None, _('end fields with NUL')),
-('I', 'include', [], _('include path in search')),
+('I', 'include', [], _('include names matching the given patterns')),
-('X', 'exclude', [], _('include path in search')),
+('X', 'exclude', [], _('include names matching the given patterns')),
-('', 'all', None, _('print all revisions with matches')),
+('', 'all', None, _('print all revisions that match')),
 ('i', 'ignore-case', None, _('ignore case when matching')),
-('l', 'files-with-matches', None, _('print names of files and revs with matches')),
+('l', 'files-with-matches', None, _('print only filenames and revs that match')),
-('n', 'line-number', None, _('print line numbers')),
+('n', 'line-number', None, _('print matching line numbers')),
-('r', 'rev', [], _('search in revision rev')),
+('r', 'rev', [], _('search in given revision range')),
-('u', 'user', None, _('print user who made change'))],
+('u', 'user', None, _('print user who committed change'))],
-_("hg grep [OPTION]... PATTERN [FILE]...")),
+"hg grep [OPTION]... PATTERN [FILE]..."),
 "heads":
 (heads,
 [('b', 'branches', None, _('find branch info'))],
 _('hg heads [-b]')),
 "help": (help_, [], _('hg help [COMMAND]')),
 "identify|id": (identify, [], _('hg identify')),
 "import|patch":
 (import_,
-[('p', 'strip', 1, _('path strip')),
+[('p', 'strip', 1, _('directory strip option for patch. This has the same\n') +
-('f', 'force', None, _('skip check for outstanding changes')),
+_('meaning as the corresponding patch option')),
+('f', 'force', None, _('skip check for outstanding uncommitted changes')),
 ('b', 'base', "", _('base path'))],
-_("hg import [-f] [-p NUM] [-b BASE] PATCH...")),
+"hg import [-f] [-p NUM] [-b BASE] PATCH..."),
 "incoming|in": (incoming,
 [('M', 'no-merges', None, _("do not show merges")),
 ('p', 'patch', None, _('show patch'))],
 _('hg incoming [-p] [SOURCE]')),
 "^init": (init, [], _('hg init [DEST]')),
 "locate":
 (locate,
-[('r', 'rev', '', _('revision')),
+[('r', 'rev', '', _('search the repository as it stood at rev')),
-('0', 'print0', None, _('end filenames with NUL')),
+('0', 'print0', None, _('end filenames with NUL, for use with xargs')),
-('f', 'fullpath', None, _('print complete paths')),
+('f', 'fullpath', None, _('print complete paths from the filesystem root')),
-('I', 'include', [], _('include path in search')),
+('I', 'include', [], _('include names matching the given patterns')),
-('X', 'exclude', [], _('exclude path from search'))],
+('X', 'exclude', [], _('exclude names matching the given patterns'))],
 _('hg locate [OPTION]... [PATTERN]...')),
 "^log|history":
 (log,
-[('I', 'include', [], _('include path in search')),
+[('I', 'include', [], _('include names matching the given patterns')),
-('X', 'exclude', [], _('exclude path from search')),
+('X', 'exclude', [], _('exclude names matching the given patterns')),
 ('b', 'branch', None, _('show branches')),
 ('k', 'keyword', [], _('search for a keyword')),
-('r', 'rev', [], _('revision')),
+('r', 'rev', [], _('show the specified revision or range')),
 ('M', 'no-merges', None, _("do not show merges")),
 ('m', 'only-merges', None, _("show only merges")),
 ('p', 'patch', None, _('show patch'))],
 _('hg log [-I] [-X] [-r REV]... [-p] [FILE]')),
 "manifest": (manifest, [], _('hg manifest [REV]')),
 _('hg outgoing [-p] [DEST]')),
 "parents": (parents, [], _('hg parents [REV]')),
 "paths": (paths, [], _('hg paths [NAME]')),
 "^pull":
 (pull,
-[('u', 'update', None, _('update working directory')),
+[('u', 'update', None, _('update the working directory to tip after pull')),
-('e', 'ssh', "", _('ssh command')),
+('e', 'ssh', "", _('specify ssh command to use')),
-('', 'remotecmd', "", _('remote hg command'))],
+('', 'remotecmd', "", _('specify hg command to run on the remote side'))],
 _('hg pull [-u] [-e FILE] [--remotecmd FILE] [SOURCE]')),
 "^push":
 (push,
 [('f', 'force', None, _('force push')),
-('e', 'ssh', "", _('ssh command')),
+('e', 'ssh', "", _('specify ssh command to use')),
-('', 'remotecmd', "", _('remote hg command'))],
+('', 'remotecmd', "", _('specify hg command to run on the remote side'))],
 _('hg push [-f] [-e FILE] [--remotecmd FILE] [DEST]')),
 "rawcommit":
 (rawcommit,
 [('p', 'parent', [], _('parent')),
 ('d', 'date', "", _('date code')),
 ('t', 'text', "", _('commit message (deprecated: use -m)')),
 ('l', 'logfile', "", _('commit message file'))],
 _('hg rawcommit [OPTION]... [FILE]...')),
 "recover": (recover, [], _("hg recover")),
 "^remove|rm": (remove,
-[('I', 'include', [], _('include path in search')),
+[('I', 'include', [], _('include names matching the given patterns')),
-('X', 'exclude', [], _('exclude path from search'))],
+('X', 'exclude', [], _('exclude names matching the given patterns'))],
 _("hg remove [OPTION]... FILE...")),
 "rename|mv": (rename,
-[('I', 'include', [], _('include path in search')),
+[('I', 'include', [], _('include names matching the given patterns')),
-('X', 'exclude', [], _('exclude path from search')),
+('X', 'exclude', [], _('exclude names matching the given patterns')),
-('A', 'after', None, _('record a copy after it has happened')),
+('A', 'after', None, _('record a rename that has already occurred')),
-('f', 'force', None, _('replace destination if it exists')),
+('f', 'force', None, _('forcibly copy over an existing managed file')),
 ('p', 'parents', None, _('append source path to dest'))],
 _('hg rename [OPTION]... [SOURCE]... DEST')),
 "^revert":
 (revert,
-[("n", "nonrecursive", None, _("don't recurse into subdirs")),
+[("n", "nonrecursive", None, _("do not recurse into subdirectories")),
-("r", "rev", "", _("revision"))],
+("r", "rev", "", _("revision to revert to"))],
 _("hg revert [-n] [-r REV] [NAME]...")),
 "root": (root, [], _("hg root")),
 "^serve":
 (serve,
-[('A', 'accesslog', '', _('access log file')),
+[('A', 'accesslog', '', _('name of access log file to write to')),
-('E', 'errorlog', '', _('error log file')),
+('E', 'errorlog', '', _('name of error log file to write to')),
-('p', 'port', 0, _('listen port')),
+('p', 'port', 0, _('port to use (default: 8000)')),
-('a', 'address', '', _('interface address')),
+('a', 'address', '', _('address to use')),
-('n', 'name', "", _('repository name')),
+('n', 'name', "", _('name to show in web pages (default: working dir)')),
 ('', 'stdio', None, _('for remote clients')),
-('t', 'templates', "", _('template directory')),
+('t', 'templates', "", _('web templates to use')),
-('', 'style', "", _('template style')),
+('', 'style', "", _('template style to use')),
 ('6', 'ipv6', None, _('use IPv6 in addition to IPv4'))],
 _("hg serve [OPTION]...")),
 "^status":
 (status,
 [('m', 'modified', None, _('show only modified files')),
 ('a', 'added', None, _('show only added files')),
 ('r', 'removed', None, _('show only removed files')),
 ('u', 'unknown', None, _('show only unknown (not tracked) files')),
 ('n', 'no-status', None, _('hide status prefix')),
-('0', 'print0', None, _('end filenames with NUL')),
+('0', 'print0', None, _('end filenames with NUL, for use with xargs')),
-('I', 'include', [], _('include path in search')),
+('I', 'include', [], _('include names matching the given patterns')),
-('X', 'exclude', [], _('exclude path from search'))],
+('X', 'exclude', [], _('exclude names matching the given patterns'))],
 _("hg status [OPTION]... [FILE]...")),
 "tag":
 (tag,
 [('l', 'local', None, _('make the tag local')),
-('m', 'message', "", _('commit message')),
+('m', 'message', "", _('message for tag commit log entry')),
 ('t', 'text', "", _('commit message (deprecated: use -m)')),
-('d', 'date', "", _('date code')),
+('d', 'date', "", _('record datecode as commit date')),
-('u', 'user', "", _('user'))],
+('u', 'user', "", _('record user as commiter'))],
 _('hg tag [OPTION]... NAME [REV]')),
 "tags": (tags, [], _('hg tags')),
 "tip": (tip, [], _('hg tip')),
 "unbundle":
 (unbundle,
 _('hg unbundle FILE')),
 "undo": (undo, [], _('hg undo')),
 "^update|up|checkout|co":
 (update,
 [('b', 'branch', "", _('checkout the head of a specific branch')),
-('m', 'merge', None, _('allow merging of conflicts')),
+('m', 'merge', None, _('allow merging of branches')),
 ('C', 'clean', None, _('overwrite locally modified files'))],
 _('hg update [-b TAG] [-m] [-C] [REV]')),
 "verify": (verify, [], _('hg verify')),
 "version": (show_version, [], _('hg version')),
 }
 globalopts = [
-('R', 'repository', "", _('repository root directory')),
+('R', 'repository', "", _("repository root directory")),
-('', 'cwd', '', _('change working directory')),
+('', 'cwd', '', _("change working directory")),
-('y', 'noninteractive', None, _('run non-interactively')),
+('y', 'noninteractive', None, _("do not prompt, assume 'yes' for any required answers")),
-('q', 'quiet', None, _('quiet mode')),
+('q', 'quiet', None, _("suppress output")),
-('v', 'verbose', None, _('verbose mode')),
+('v', 'verbose', None, _("enable additional output")),
-('', 'debug', None, _('debug mode')),
+('', 'debug', None, _("enable debugging output")),
-('', 'debugger', None, _('start debugger')),
+('', 'debugger', None, _("start debugger")),
-('', 'traceback', None, _('print traceback on exception')),
+('', 'traceback', None, _("print traceback on exception")),
-('', 'time', None, _('time how long the command takes')),
+('', 'time', None, _("time how long the command takes")),
-('', 'profile', None, _('profile')),
+('', 'profile', None, _("print command execution profile")),
-('', 'version', None, _('output version information and exit')),
+('', 'version', None, _("output version information and exit")),
-('h', 'help', None, _('display help and exit')),
+('h', 'help', None, _("display help and exit")),
 ]
 norepo = ("clone init version help debugancestor debugconfig debugdata"
 " debugindex debugindexdot paths")

Mercurial > hg > pyhgsh

comparison mercurial/commands.py @ 1437:ea51d296085f