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

comparison mercurial/commands.py @ 11177:6a64813276ed

commands: initial audit of exit codes bisect: clarify None return bundle: return 1 on no changes clone: return result code copy: limit errors to 0/1 commit: return 1 on no changes forget: return 1 on errors grep: return 1 if no match found remove: return 1 on errors resolve: return 1 if something fails to resolve rollback: return 1 if no rollback data

author	Matt Mackall <mpm@selenic.com>
date	Sat, 15 May 2010 17:48:49 -0500
parents	5b48d819d5f9
children	aad0c319b96e

comparison

equal deleted inserted replaced

-:ed5d2a7c4b73
+:6a64813276ed
 parameter greater than 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 parameter. Detecting renamed files this way
 can be expensive.
+Returns 0 if all files are successfully added.
 """
 try:
 sim = float(opts.get('similarity') or 0)
 except ValueError:
 raise util.Abort(_('similarity must be a number'))
 Without the -a/--text option, annotate will avoid processing files
 it detects as binary. With -a, annotate will annotate the file
 anyway, although the results will probably be neither useful
 nor desirable.
+Returns 0 on success.
 """
 if opts.get('follow'):
 # --follow is deprecated and now just an alias for -f/--file
 # to mimic the behavior of Mercurial before version 1.5
 opts['file'] = 1
 Each member added to an archive file has a directory prefix
 prepended. Use -p/--prefix to specify a format string for the
 prefix. The default is the basename of the archive, with suffixes
 removed.
+Returns 0 on success.
 '''
 ctx = repo[opts.get('rev')]
 if not ctx:
 raise util.Abort(_('no working directory: please specify a revision'))
 before starting the backout, then merges the new head with that
 changeset afterwards. This saves you from doing the merge by hand.
 The result of this merge is not committed, as with a normal merge.
 See :hg:`help dates` for a list of formats valid for -d/--date.
+Returns 0 on success.
 '''
 if rev and node:
 raise util.Abort(_("please specify just one revision"))
 if not rev:
 If you supply a command, it will be used for automatic bisection.
 Its exit status will be used to mark revisions as good or bad:
 status 0 means good, 125 means to skip the revision, 127
 (command not found) will abort the bisection, and any other
 non-zero exit status means the revision is bad.
+Returns 0 on success.
 """
 def print_result(nodes, good):
 displayer = cmdutil.show_changeset(ui, repo, {})
 if len(nodes) == 1:
 # narrowed it down to a single revision
 # update to next check
 cmdutil.bail_if_changed(repo)
 hg.clean(repo, nodes[0], show_stats=False)
 finally:
 hbisect.save_state(repo, state)
-return print_result(nodes, good)
+print_result(nodes, good)
+return
 # update state
 node = repo.lookup(rev or '.')
 if good or bad or skip:
 if good:
 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.
+Returns 0 on success.
 """
 if opts.get('clean'):
 label = repo[None].parents()[0].branch()
 repo.dirstate.setbranch(label)
 If -a/--active is specified, only show active branches. A branch
 is considered active if it contains repository heads.
 Use the command :hg:`update` to switch to an existing branch.
+Returns 0.
 """
 hexfunc = ui.debugflag and hex or short
 activebranches = [repo[n].branch() for n in repo.heads()]
 def testactive(tag, node):
 command. This is useful when direct push and pull are not
 available or when exporting an entire repository is undesirable.
 Applying bundles preserves all changeset contents including
 permissions, copy/rename information, and revision history.
+Returns 0 on success, 1 if no changes found.
 """
 revs = opts.get('rev') or None
 if revs:
 revs = [repo.lookup(rev) for rev in revs]
 if opts.get('all'):
 revs, checkout = hg.addbranchrevs(repo, other, branches, revs)
 o = repo.findoutgoing(other, force=opts.get('force'))
 if not o:
 ui.status(_("no changes found\n"))
-return
+return 1
 if revs:
 cg = repo.changegroupsubset(o, revs, 'bundle')
 else:
 cg = repo.changegroup(o, 'bundle')
 for the export 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
+Returns 0 on success.
 """
 ctx = repo[opts.get('rev')]
 err = 1
 m = cmdutil.match(repo, (file1,) + pats, opts)
 for abs in ctx.walk(m):
 d) the changeset specified with -r
 e) the tipmost head specified with -b
 f) the tipmost head specified with the url#branch source syntax
 g) the tipmost head of the default branch
 h) tip
+Returns 0 on success.
 """
 if opts.get('noupdate') and opts.get('updaterev'):
 raise util.Abort(_("cannot specify both --noupdate and --updaterev"))
-hg.clone(cmdutil.remoteui(ui, opts), source, dest,
+r = hg.clone(cmdutil.remoteui(ui, opts), source, dest,
 pull=opts.get('pull'),
 stream=opts.get('uncompressed'),
 rev=opts.get('rev'),
 update=opts.get('updaterev') or not opts.get('noupdate'),
 branch=opts.get('branch'))
+return r is None
 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
 If no commit message is specified, the configured editor is
 started to prompt you for a message.
 See :hg:`help dates` for a list of formats valid for -d/--date.
+Returns 0 on success, 1 if nothing changed.
 """
 extra = {}
 if opts.get('close_branch'):
 if repo['.'].node() not in repo.branchheads():
 # The topo heads set is included in the branch heads set of the
 bheads = repo.branchheads(branch)
 node = cmdutil.commit(ui, repo, commitfunc, pats, opts)
 if not node:
 ui.status(_("nothing changed\n"))
-return
+return 1
 ctx = repo[node]
 parents = ctx.parents()
 if bheads and [x for x in parents if x.node() not in bheads]:
 exist in the working directory. If invoked with -A/--after, the
 operation is recorded, but no copying is performed.
 This command takes effect with the next commit. To undo a copy
 before that, see hg revert.
+Returns 0 on success, 1 if errors are encountered.
 """
 wlock = repo.wlock(False)
 try:
 return cmdutil.copy(ui, repo, pats, opts)
 finally:
 raise util.Abort(_('either two or three arguments required'))
 a = r.ancestor(lookup(rev1), lookup(rev2))
 ui.write("%d:%s\n" % (r.rev(a), hex(a)))
 def debugcommands(ui, cmd='', *args):
+"""list all available commands and options"""
 for cmd, vals in sorted(table.iteritems()):
 cmd = cmd.split('|')[0].strip('^')
 opts = ', '.join([i[1] for i in vals[1]])
 ui.write('%s: %s\n' % (cmd, opts))
 if ui.verbose:
 cmdlist = [' '.join(c[0]) for c in cmdlist.values()]
 ui.write("%s\n" % "\n".join(sorted(cmdlist)))
 def debugfsinfo(ui, path = "."):
+"""show information detected about current filesystem"""
 open('.debugfsinfo', 'w').write('')
 ui.write('exec: %s\n' % (util.checkexec(path) and 'yes' or 'no'))
 ui.write('symlink: %s\n' % (util.checklink(path) and 'yes' or 'no'))
 ui.write('case-sensitive: %s\n' % (util.checkcase('.debugfsinfo')
 and 'yes' or 'no'))
 With multiple arguments, print names and values of all config
 items with matching section names.
 With --debug, the source (filename and line number) is printed
 for each config item.
+Returns 0 on success.
 """
 for f in util.rcpath():
 ui.debug(_('read config from: %s\n') % f)
 untrusted = bool(opts.get('untrusted'))
 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
 be used with care.
+Returns 0 on success.
 """
 if not rev2:
 rev2 = hex(nullid)
 if pp[1] != nullid:
 ui.write("\t%d -> %d\n" % (r.rev(pp[1]), i))
 ui.write("}\n")
 def debuginstall(ui):
-'''test Mercurial installation'''
+'''test Mercurial installation
+Returns 0 on success.
+'''
 def writetemp(contents):
 (fd, name) = tempfile.mkstemp(prefix="hg-debuginstall-")
 f = os.fdopen(fd, "wb")
 f.write(contents)
 files it detects as binary. With -a, diff will generate a diff
 anyway, probably with undesirable results.
 Use the -g/--git option to generate diffs in the git extended diff
 format. For more information, read :hg:`help diffs`.
+Returns 0 on success.
 """
 revs = opts.get('rev')
 change = opts.get('change')
 stat = opts.get('stat')
 Use the -g/--git option to generate diffs in the git extended diff
 format. See :hg:`help diffs` for more information.
 With the --switch-parent option, the diff will be against the
 second parent. It can be useful to review a merge.
+Returns 0 on success.
 """
 changesets += tuple(opts.get('rev', []))
 if not changesets:
 raise util.Abort(_("export requires at least one changeset"))
 revs = cmdutil.revrange(repo, changesets)
 This only removes files from the current branch, not from the
 entire project history, and it does not delete them from the
 working directory.
 To undo a forget before the next commit, see hg add.
+Returns 0 on success.
 """
 if not pats:
 raise util.Abort(_('no files specified'))
 m = cmdutil.match(repo, pats, opts)
 s = repo.status(match=m, clean=True)
 forget = sorted(s[0] + s[1] + s[3] + s[6])
+errs = 0
 for f in m.files():
 if f not in repo.dirstate and not os.path.isdir(m.rel(f)):
 ui.warn(_('not removing %s: file is already untracked\n')
 % m.rel(f))
+errs = 1
 for f in forget:
 if ui.verbose or not m.exact(f):
 ui.status(_('removing %s\n') % m.rel(f))
 repo.remove(forget, unlink=False)
+return errs
 def grep(ui, repo, pattern, *pats, **opts):
 """search for a pattern in specified files and revisions
 Search revisions of files for a regular expression.
 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.
+Returns 0 if a match is found, 1 otherwise.
 """
 reflags = 0
 if opts.get('ignore_case'):
 reflags |= re.I
 try:
 regexp = re.compile(pattern, reflags)
 except Exception, inst:
 ui.warn(_("grep: invalid match pattern: %s\n") % inst)
-return None
+return 1
 sep, eol = ':', '\n'
 if opts.get('print0'):
 sep = eol = '\0'
 getfile = util.lrucachefunc(repo.file)
 if copy:
 skip[copy] = True
 del matches[rev]
 del revfiles[rev]
+return not found
 def heads(ui, repo, *branchrevs, **opts):
 """show current repository heads or show branch heads
 With no arguments, show all repository branch heads.
 If STARTREV is specified, only those heads that are descendants of
 STARTREV will be displayed.
 If -t/--topo is specified, named branch mechanics will be ignored and only
 changesets without children will be shown.
+Returns 0 if matching heads are found, 1 if not.
 """
 if opts.get('rev'):
 start = repo.lookup(opts['rev'])
 else:
 """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
-topic."""
+topic.
+Returns 0 if successful.
+"""
 option_lists = []
 textwidth = util.termwidth() - 2
 def addglobalopts(aliases):
 if ui.verbose:
 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, a list of tags for
 this revision and a branch name for non-default branches.
+Returns 0 if successful.
 """
 if not repo and not source:
 raise util.Abort(_("There is no Mercurial repository here "
 "(.hg not found)"))
 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` for a list of formats valid for -d/--date.
+Returns 0 on success.
 """
 patches = (patch1,) + patches
 date = opts.get('date')
 if date:
 For remote repository, using --bundle avoids downloading the
 changesets twice if the incoming is followed by a pull.
 See pull for valid source format details.
+Returns 0 if there are incoming changes, 1 otherwise.
 """
 limit = cmdutil.loglimit(opts)
 source, branches = hg.parseurl(ui.expandpath(source), opts.get('branch'))
 other = hg.repository(cmdutil.remoteui(repo, opts), source)
 ui.status(_('comparing with %s\n') % url.hidepassword(source))
 If no directory is given, the current directory is used.
 It is possible to specify an ``ssh://`` URL as the destination.
 See :hg:`help urls` for more information.
+Returns 0 on success.
 """
 hg.repository(cmdutil.remoteui(ui, opts), dest, create=1)
 def locate(ui, repo, *pats, **opts):
 """locate files matching specific patterns
 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 whitespace as multiple filenames.
+Returns 0 if a match is found, 1 otherwise.
 """
 end = opts.get('print0') and '\0' or '\n'
 rev = opts.get('rev') or None
 ret = 1
 NOTE: log -p/--patch may generate unexpected diff output for merge
 changesets, as it will only compare the merge changeset against
 its first parent. Also, only files different from BOTH parents
 will appear in files:.
+Returns 0 on success.
 """
 matchfn = cmdutil.match(repo, pats, opts)
 limit = cmdutil.loglimit(opts)
 count = 0
 If no revision is given, the first parent of the working directory
 is used, or the null revision if no revision is checked out.
 With -v, print file permissions, symlink and executable bits.
 With --debug, print file revision hashes.
+Returns 0 on success.
 """
 if rev and node:
 raise util.Abort(_("please specify just one revision"))
 If no revision is specified, the working directory's parent is a
 head revision, and the current branch contains exactly one other
 head, the other head is merged with by default. Otherwise, an
 explicit revision with which to merge with must be provided.
+Returns 0 on success, 1 if there are unresolved files.
 """
 if opts.get('rev') and node:
 raise util.Abort(_("please specify just one revision"))
 if not node:
 Show changesets not found in the specified destination repository
 or the default push location. These are the changesets that would
 be pushed if a push was requested.
 See pull for details of valid destination formats.
+Returns 0 if there are outgoing changes, 1 otherwise.
 """
 limit = cmdutil.loglimit(opts)
 dest = ui.expandpath(dest or 'default-push', dest or 'default')
 dest, branches = hg.parseurl(dest, opts.get('branch'))
 revs, checkout = hg.addbranchrevs(repo, repo, branches, opts.get('rev'))
 Print the working directory's parent revisions. If a revision is
 given via -r/--rev, the parent of that revision will be printed.
 If a file argument is given, the revision in which the file was
 last changed (before the working directory revision or the
 argument to --rev if given) is printed.
+Returns 0 on success.
 """
 rev = opts.get('rev')
 if rev:
 ctx = repo[rev]
 else:
 added those changes to the repository, you should use pull -r X
 where X is the last changeset listed by hg incoming.
 If SOURCE is omitted, the 'default' path will be used.
 See :hg:`help urls` for more information.
+Returns 0 on success, 1 if an update had unresolved files.
 """
 source, branches = hg.parseurl(ui.expandpath(source), opts.get('branch'))
 other = hg.repository(cmdutil.remoteui(repo, opts), source)
 ui.status(_('pulling from %s\n') % url.hidepassword(source))
 revs, checkout = hg.addbranchrevs(repo, other, branches, opts.get('rev'))
 If -r/--rev is used, the named revision and all its ancestors will
 be pushed to the remote repository.
 Please see :hg:`help urls` for important details about ``ssh://``
 URLs. If DESTINATION is omitted, a default path will be used.
+Returns 0 if push was successful, 1 if nothing to push.
 """
 dest = ui.expandpath(dest or 'default-push', dest or 'default')
 dest, branches = hg.parseurl(dest, opts.get('branch'))
 revs, checkout = hg.addbranchrevs(repo, repo, branches, opts.get('rev'))
 other = hg.repository(cmdutil.remoteui(repo, opts), dest)
 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.
+Returns 0 if successful, 1 if nothing to recover or verify fails.
 """
 if repo.recover():
 return hg.verify(repo)
 return 1
 -A     W  W  W  R
 -Af    R  R  R  R
 This command schedules the files to be removed at the next commit.
 To undo a remove before that, see hg revert.
-"""
+Returns 0 on success, 1 if any warnings encountered.
+"""
+ret = 0
 after, force = opts.get('after'), opts.get('force')
 if not pats and not after:
 raise util.Abort(_('no files specified'))
 m = cmdutil.match(repo, pats, opts)
 modified, added, deleted, clean = s[0], s[1], s[3], s[6]
 for f in m.files():
 if f not in repo.dirstate and not os.path.isdir(m.rel(f)):
 ui.warn(_('not removing %s: file is untracked\n') % m.rel(f))
+ret = 1
 def warn(files, reason):
 for f in files:
 ui.warn(_('not removing %s: file %s (use -f to force removal)\n')
 % (m.rel(f), reason))
+ret = 1
 if force:
 remove, forget = modified + deleted + clean, added
 elif after:
 remove, forget = deleted, []
 if ui.verbose or not m.exact(f):
 ui.status(_('removing %s\n') % m.rel(f))
 repo.forget(forget)
 repo.remove(remove, unlink=not after)
+return ret
 def rename(ui, repo, *pats, **opts):
 """rename files; equivalent of copy + remove
 Mark dest as copies of sources; mark sources for deletion. If dest
 exist in the working directory. If invoked with -A/--after, the
 operation is recorded, but no copying is performed.
 This command takes effect at the next commit. To undo a rename
 before that, see hg revert.
+Returns 0 on success, 1 if errors are encountered.
 """
 wlock = repo.wlock(False)
 try:
 return cmdutil.copy(ui, repo, pats, opts, rename=True)
 finally:
 (or ``-a`` for all unresolved files)
 Note that Mercurial will not let you commit files with unresolved merge
 conflicts.  You must use ``hg resolve -m ...`` before you can commit
 after a conflicting merge.
+Returns 0 on success, 1 if any files fail a resolve attempt.
 """
 all, mark, unmark, show, nostatus = \
 [opts.get(o) for o in 'all mark unmark list no_status'.split()]
 raise util.Abort(_('no files or directories specified; '
 'use --all to remerge all files'))
 ms = mergemod.mergestate(repo)
 m = cmdutil.match(repo, pats, opts)
+ret = 0
 for f in ms:
 if m(f):
 if show:
 if nostatus:
 # backup pre-resolve (merge uses .orig for its own purposes)
 a = repo.wjoin(f)
 util.copyfile(a, a + ".resolve")
 # resolve file
-ms.resolve(f, wctx, mctx)
+if ms.resolve(f, wctx, mctx):
+ret = 1
 # replace filemerge's .orig file with our resolve file
 util.rename(a + ".resolve", a + ".orig")
+return ret
 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
 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.
+Returns 0 on success.
 """
 if opts["date"]:
 if opts["rev"]:
 raise util.Abort(_("you can't specify a revision and a date"))
 changes are visible for pull by other users, rolling a transaction
 back locally is ineffective (someone else may already have pulled
 the changes). Furthermore, a race is possible with readers of the
 repository; for example an in-progress pull from the repository
 may fail if a rollback is performed.
-"""
-repo.rollback(opts.get('dry_run'))
+Returns 0 on success, 1 if no rollback data is available.
+"""
+return repo.rollback(opts.get('dry_run'))
 def root(ui, repo):
 """print the root (top) of the current working directory
 Print the root directory of the current repository.
+Returns 0 on success.
 """
 ui.write(repo.root + "\n")
 def serve(ui, repo, **opts):
 """start stand-alone webserver
 files.
 To have the server choose a free port number to listen on, specify
 a port number of 0; in this case, the server will print the port
 number it uses.
+Returns 0 on success.
 """
 if opts["stdio"]:
 if repo is None:
 raise error.RepoError(_("There is no Mercurial repository here"
 C = clean
 ! = missing (deleted by non-hg command, but still tracked)
 ? = not tracked
 I = ignored
 = origin of the previous file listed as A (added)
+Returns 0 on success.
 """
 revs = opts.get('rev')
 change = opts.get('change')
 This generates a brief summary of the working directory state,
 including parents, branch, commit status, and available updates.
 With the --remote option, this will check the default paths for
 incoming and outgoing changes. This can be time-consuming.
+Returns 0 on success.
 """
 ctx = repo[None]
 parents = ctx.parents()
 pnode = parents[0].node()
 See :hg:`help dates` for a list of formats valid for -d/--date.
 Since tag names have priority over branch names during revision
 lookup, using an existing branch name as a tag name is discouraged.
+Returns 0 on success.
 """
 rev_ = "."
 names = [t.strip() for t in (name1,) + names]
 if len(names) != len(set(names)):
 def tags(ui, repo):
 """list repository tags
 This lists both regular and local tags. When the -v/--verbose
 switch is used, a third column "local" is printed for local tags.
+Returns 0 on success.
 """
 hexfunc = ui.debugflag and hex or short
 tagtype = ""
 If you have just made a commit, that commit will be the tip. If
 you have just pulled changes from another repository, the tip of
 that repository becomes the current tip. The "tip" tag is special
 and cannot be renamed or assigned to a different changeset.
+Returns 0 on success.
 """
 displayer = cmdutil.show_changeset(ui, repo, opts)
 displayer.show(repo[len(repo) - 1])
 displayer.close()
 def unbundle(ui, repo, fname1, *fnames, **opts):
 """apply one or more changegroup files
 Apply one or more compressed changegroup files generated by the
 bundle command.
+Returns 0 on success, 1 if an update has unresolved files.
 """
 fnames = (fname1,) + fnames
 lock = repo.lock()
 try:
 :hg:`clone -U`).
 If you want to update just one file to an older changeset, use :hg:`revert`.
 See :hg:`help dates` for a list of formats valid for -d/--date.
+Returns 0 on success, 1 if there are unresolved files.
 """
 if rev and node:
 raise util.Abort(_("please specify just one revision"))
 if not rev:
 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.
+Returns 0 on success, 1 if errors are encountered.
 """
 return hg.verify(repo)
 def version_(ui):
 """output version and copyright information"""

Mercurial > public > mercurial-scm > hg

comparison mercurial/commands.py @ 11177:6a64813276ed