hg help improvements

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

hg help improvements

Handle showing option help in commands.py rather than fancyopts
Show getopt exception string if argument parsing fails and call help
Show help for invalid arguments
Show exception string for invalid arguments with -d

manifest hash: 9bd3e908cc080c21bb5e85822f675c35a8396fef
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.0 (GNU/Linux)

iD8DBQFCp8GNywK+sNU5EO8RAoJfAJ4pB0I4xH4CTuGmAwArfBzIsT9plACeImkm
4ml9x78fmPgKpDYIr/qhfVY=
=YeZv
-----END PGP SIGNATURE-----

mercurial/commands.py

@@ -1,633 +1,650 b''
 # commands.py - command processing for mercurial
 #
 # Copyright 2005 Matt Mackall <[e-mail]>
 #
 # This software may be used and distributed according to the terms
 # of the GNU General Public License, incorporated herein by reference.
 
 import os, re, sys, signal
 import fancyopts, ui, hg
 from demandload import *
 demandload(globals(), "mdiff time hgweb traceback")
 
 class UnknownCommand(Exception): pass
 
 def filterfiles(filters, files):
     l = [ x for x in files if x in filters ]
 
     for t in filters:
         if t and t[-1] != os.sep: t += os.sep
         l += [ x for x in files if x.startswith(t) ]
     return l
 
 def relfilter(repo, files):
     if os.getcwd() != repo.root:
         p = os.getcwd()[len(repo.root) + 1: ]
         return filterfiles([p], files)
     return files
 
 def relpath(repo, args):
     if os.getcwd() != repo.root:
         p = os.getcwd()[len(repo.root) + 1: ]
         return [ os.path.normpath(os.path.join(p, x)) for x in args ]
     return args
 
 def dodiff(repo, files = None, node1 = None, node2 = None):
     def date(c):
         return time.asctime(time.gmtime(float(c[2].split(' ')[0])))
 
     if node2:
         change = repo.changelog.read(node2)
         mmap2 = repo.manifest.read(change[0])
         (c, a, d) = repo.diffrevs(node1, node2)
         def read(f): return repo.file(f).read(mmap2[f])
         date2 = date(change)
     else:
         date2 = time.asctime()
         (c, a, d, u) = repo.diffdir(repo.root, node1)
         if not node1:
             node1 = repo.dirstate.parents()[0]
         def read(f): return file(os.path.join(repo.root, f)).read()
 
     change = repo.changelog.read(node1)
     mmap = repo.manifest.read(change[0])
     date1 = date(change)
 
     if files:
         c, a, d = map(lambda x: filterfiles(files, x), (c, a, d))
 
     for f in c:
         to = None
         if f in mmap:
             to = repo.file(f).read(mmap[f])
         tn = read(f)
         sys.stdout.write(mdiff.unidiff(to, date1, tn, date2, f))
     for f in a:
         to = None
         tn = read(f)
         sys.stdout.write(mdiff.unidiff(to, date1, tn, date2, f))
     for f in d:
         to = repo.file(f).read(mmap[f])
         tn = None
         sys.stdout.write(mdiff.unidiff(to, date1, tn, date2, f))
     
 def help(ui, cmd=None):
     '''show help for a given command or all commands'''
     if cmd:
         try:
             i = find(cmd)
             ui.write("%s\n\n" % i[2])
+
+            if i[1]:
+                for s, l, d, c in i[1]:
+                    opt=' '
+                    if s: opt = opt + '-' + s + ' '
+                    if l: opt = opt + '--' + l + ' '
+                    if d: opt = opt + '(' + str(d) + ')'
+                    ui.write(opt, "\n")
+                    if c: ui.write('   %s\n' % c)
+                ui.write("\n")
+
             ui.write(i[0].__doc__, "\n")
         except UnknownCommand:
             ui.warn("hg: unknown command %s\n" % cmd)
         sys.exit(0)
     else:
         ui.status('hg commands:\n\n')
 
         h = {}
         for e in table.values():
             f = e[0]
             if f.__name__.startswith("debug"): continue
             d = ""
             if f.__doc__:
                 d = f.__doc__.splitlines(0)[0].rstrip()
             h[f.__name__] = d
 
         fns = h.keys()
         fns.sort()
         m = max(map(len, fns))
         for f in fns:
             ui.status(' %-*s   %s\n' % (m, f, h[f]))
 
 # Commands start here, listed alphabetically
 
 def add(ui, repo, file, *files):
     '''add the specified files on the next commit'''
     repo.add(relpath(repo, (file,) + files))
 
 def addremove(ui, repo):
     """add all new files, delete all missing files"""
     (c, a, d, u) = repo.diffdir(repo.root)
     repo.add(u)
     repo.remove(d)
 
 def annotate(u, repo, file, *files, **ops):
     """show changeset information per file line"""
     def getnode(rev):
         return hg.short(repo.changelog.node(rev))
 
     def getname(rev):
         try:
             return bcache[rev]
         except KeyError:
             cl = repo.changelog.read(repo.changelog.node(rev))
             name = cl[1]
             f = name.find('@')
             if f >= 0:
                 name = name[:f]
             bcache[rev] = name
             return name
     
     bcache = {}
     opmap = [['user', getname], ['number', str], ['changeset', getnode]]
     if not ops['user'] and not ops['changeset']:
         ops['number'] = 1
 
     node = repo.dirstate.parents()[0]
     if ops['revision']:
         node = repo.changelog.lookup(ops['revision'])
     change = repo.changelog.read(node)
     mmap = repo.manifest.read(change[0])
     maxuserlen = 0
     maxchangelen = 0
     for f in relpath(repo, (file,) + files):
         lines = repo.file(f).annotate(mmap[f])
         pieces = []
 
         for o, f in opmap:
             if ops[o]:
                 l = [ f(n) for n,t in lines ]
                 m = max(map(len, l))
                 pieces.append([ "%*s" % (m, x) for x in l])
 
         for p,l in zip(zip(*pieces), lines):
             u.write(" ".join(p) + ": " + l[1])
 
 def cat(ui, repo, file, rev = []):
     """output the latest or given revision of a file"""
     r = repo.file(relpath(repo, [file])[0])
     n = r.tip()
     if rev: n = r.lookup(rev)
     sys.stdout.write(r.read(n))
 
 def commit(ui, repo, *files, **opts):
     """commit the specified files or all outstanding changes"""
     text = opts['text']
     if not text and opts['logfile']:
         try: text = open(opts['logfile']).read()
         except IOError: pass
 
     repo.commit(relpath(repo, files), text)
 
 def debugaddchangegroup(ui, repo):
     data = sys.stdin.read()
     repo.addchangegroup(data)
 
 def debugchangegroup(ui, repo, roots):
     newer = repo.newer(map(repo.lookup, roots))
     for chunk in repo.changegroup(newer):
         sys.stdout.write(chunk)
 
 def debugindex(ui, file):
     r = hg.revlog(open, file, "")
     print "   rev    offset  length   base linkrev"+\
           " p1           p2           nodeid"
     for i in range(r.count()):
         e = r.index[i]
         print "% 6d % 9d % 7d % 6d % 7d %s.. %s.. %s.." % (
             i, e[0], e[1], e[2], e[3],
             hg.hex(e[4][:5]), hg.hex(e[5][:5]), hg.hex(e[6][:5]))
 
 def debugindexdot(ui, file):
     r = hg.revlog(open, file, "")
     print "digraph G {"
     for i in range(r.count()):
         e = r.index[i]
         print "\t%d -> %d" % (r.rev(e[4]), i)
         if e[5] != hg.nullid:
             print "\t%d -> %d" % (r.rev(e[5]), i)
     print "}"
 
 def diff(ui, repo, *files, **opts):
     """diff working directory (or selected files)"""
     revs = []
     if opts['rev']:
         revs = map(lambda x: repo.lookup(x), opts['rev'])
     
     if len(revs) > 2:
         self.ui.warn("too many revisions to diff\n")
         sys.exit(1)
 
     if files:
         files = relpath(repo, files)
     else:
         files = relpath(repo, [""])
 
     dodiff(repo, files, *revs)
 
 def export(ui, repo, changeset):
     """dump the changeset header and diffs for a revision"""
     node = repo.lookup(changeset)
     prev, other = repo.changelog.parents(node)
     change = repo.changelog.read(node)
     print "# HG changeset patch"
     print "# User %s" % change[1]
     print "# Node ID %s" % hg.hex(node)
     print "# Parent  %s" % hg.hex(prev)
     print
     if other != hg.nullid:
         print "# Parent  %s" % hg.hex(other)
     print change[4].rstrip()
     print
     
     dodiff(repo, None, prev, node)
 
 def forget(ui, repo, file, *files):
     """don't add the specified files on the next commit"""
     repo.forget(relpath(repo, (file,) + files))
 
 def heads(ui, repo):
     '''show current repository heads'''
     for n in repo.changelog.heads():
         i = repo.changelog.rev(n)
         changes = repo.changelog.read(n)
         (p1, p2) = repo.changelog.parents(n)
         (h, h1, h2) = map(hg.hex, (n, p1, p2))
         (i1, i2) = map(repo.changelog.rev, (p1, p2))
         print "rev:      %4d:%s" % (i, h)
         print "parents:  %4d:%s" % (i1, h1)
         if i2: print "          %4d:%s" % (i2, h2)
         print "manifest: %4d:%s" % (repo.manifest.rev(changes[0]),
                                     hg.hex(changes[0]))
         print "user:", changes[1]
         print "date:", time.asctime(
             time.localtime(float(changes[2].split(' ')[0])))
         if ui.verbose: print "files:", " ".join(changes[3])
         print "description:"
         print changes[4]
 
 def history(ui, repo):
     """show the changelog history"""
     for i in range(repo.changelog.count() - 1, -1, -1):
         n = repo.changelog.node(i)
         changes = repo.changelog.read(n)
         (p1, p2) = repo.changelog.parents(n)
         (h, h1, h2) = map(hg.hex, (n, p1, p2))
         (i1, i2) = map(repo.changelog.rev, (p1, p2))
         print "rev:      %4d:%s" % (i, h)
         print "parents:  %4d:%s" % (i1, h1)
         if i2: print "          %4d:%s" % (i2, h2)
         print "manifest: %4d:%s" % (repo.manifest.rev(changes[0]),
                                     hg.hex(changes[0]))
         print "user:", changes[1]
         print "date:", time.asctime(
             time.localtime(float(changes[2].split(' ')[0])))
         if ui.verbose: print "files:", " ".join(changes[3])
         print "description:"
         print changes[4]
 
 def init(ui, source=None):
     """create a new repository or copy an existing one"""
 
     if source:
         paths = {}
         for name, path in ui.configitems("paths"):
             paths[name] = path
 
         if source in paths: source = paths[source]
 
         link = 0
         if not source.startswith("http://"):
             d1 = os.stat(os.getcwd()).st_dev
             d2 = os.stat(source).st_dev
             if d1 == d2: link = 1
 
         if link:
             ui.debug("copying by hardlink\n")
             os.system("cp -al %s/.hg .hg" % source)
         else:
             repo = hg.repository(ui, ".", create=1)
             other = hg.repository(ui, source)
             cg = repo.getchangegroup(other)
             repo.addchangegroup(cg)
     else:
         hg.repository(ui, ".", create=1)
     
 def log(ui, repo, f):
     """show the revision history of a single file"""
     f = relpath(repo, [f])[0]
 
     r = repo.file(f)
     for i in range(r.count() - 1, -1, -1):
         n = r.node(i)
         (p1, p2) = r.parents(n)
         (h, h1, h2) = map(hg.hex, (n, p1, p2))
         (i1, i2) = map(r.rev, (p1, p2))
         cr = r.linkrev(n)
         cn = hg.hex(repo.changelog.node(cr))
         print "rev:       %4d:%s" % (i, h)
         print "changeset: %4d:%s" % (cr, cn)
         print "parents:   %4d:%s" % (i1, h1)
         if i2: print "           %4d:%s" % (i2, h2)
         changes = repo.changelog.read(repo.changelog.node(cr))
         print "user: %s" % changes[1]
         print "date: %s" % time.asctime(
             time.localtime(float(changes[2].split(' ')[0])))
         print "description:"
         print changes[4].rstrip()
         print
 
 def manifest(ui, repo, rev = []):
     """output the latest or given revision of the project manifest"""
     n = repo.manifest.tip()
     if rev:
         n = repo.manifest.lookup(rev)
     m = repo.manifest.read(n)
     mf = repo.manifest.readflags(n)
     files = m.keys()
     files.sort()
 
     for f in files:
         ui.write("%40s %3s %s\n" % (hg.hex(m[f]), mf[f] and "755" or "644", f))
 
 def parents(ui, repo, node = None):
     '''show the parents of the current working dir'''
     if node:
         p = repo.changelog.parents(repo.lookup(hg.bin(node)))
     else:
         p = repo.dirstate.parents()
 
     for n in p:
         if n != hg.nullid:
             ui.write("%d:%s\n" % (repo.changelog.rev(n), hg.hex(n)))
 
 def patch(ui, repo, patches, **opts):
     """import an ordered set of patches"""
     try:
         import psyco
         psyco.full()
     except:
         pass
     
     d = opts["base"]
     strip = opts["strip"]
     quiet = opts["quiet"] and "> /dev/null" or ""
 
     for patch in patches:
         ui.status("applying %s\n" % patch)
         pf = os.path.join(d, patch)
 
         text = ""
         for l in file(pf):
             if l[:4] == "--- ": break
             text += l
 
         f = os.popen("lsdiff --strip %d %s" % (strip, pf))
         files = filter(None, map(lambda x: x.rstrip(), f.read().splitlines()))
         f.close()
 
         if files:
             if os.system("patch -p%d < %s %s" % (strip, pf, quiet)):
                 raise "patch failed!"
         repo.commit(files, text)
 
 def pull(ui, repo, source):
     """pull changes from the specified source"""
     paths = {}
     for name, path in ui.configitems("paths"):
         paths[name] = path
 
     if source in paths: source = paths[source]
     
     other = hg.repository(ui, source)
     cg = repo.getchangegroup(other)
     repo.addchangegroup(cg)
 
 def rawcommit(ui, repo, files, **rc):
     "raw commit interface"
 
     text = rc['text']
     if not text and rc['logfile']:
         try: text = open(rc['logfile']).read()
         except IOError: pass
     if not text and not rc['logfile']:
         print "missing commit text"
         return 1
 
     files = relpath(repo, files)
     if rc['files']:
         files += open(rc['files']).read().splitlines()
         
     repo.rawcommit(files, text, rc['user'], rc['date'], *rc['parent'])
  
 def recover(ui, repo):
     """roll back an interrupted transaction"""
     repo.recover()
 
 def remove(ui, repo, file, *files):
     """remove the specified files on the next commit"""
     repo.remove(relpath(repo, (file,) + files))
 
 def serve(ui, repo, **opts):
     """export the repository via HTTP"""
     hgweb.server(repo.root, opts["name"], opts["templates"],
                  opts["address"], opts["port"])
     
 def status(ui, repo):
     '''show changed files in the working directory
 
     C = changed
     A = added
     R = removed
     ? = not tracked'''
     
     (c, a, d, u) = repo.diffdir(repo.root)
     (c, a, d, u) = map(lambda x: relfilter(repo, x), (c, a, d, u))
 
     for f in c: print "C", f
     for f in a: print "A", f
     for f in d: print "R", f
     for f in u: print "?", f
 
 def tags(ui, repo):
     """list repository tags"""
     repo.lookup(0) # prime the cache
     i = repo.tags.items()
     n = []
     for e in i:
         try:
             l = repo.changelog.rev(e[1])
         except KeyError:
             l = -2
         n.append((l, e))
 
     n.sort()
     n.reverse()
     i = [ e[1] for e in n ]
     for k, n in i:
         try:
             r = repo.changelog.rev(n)
         except KeyError:
             r = "?"
         print "%-30s %5d:%s" % (k, repo.changelog.rev(n), hg.hex(n))
 
 def tip(ui, repo):
     """show the tip revision"""
     n = repo.changelog.tip()
     t = repo.changelog.rev(n)
     ui.status("%d:%s\n" % (t, hg.hex(n)))
 
 def undo(ui, repo):
     """undo the last transaction"""
     repo.undo()
 
 def update(ui, repo, node=None, merge=False, clean=False):
     '''update or merge working directory
 
     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.
     '''
     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"""
     return repo.verify()
 
 # Command options and aliases are listed here, alphabetically
 
 table = {
     "add": (add, [], "hg add [files]"),
     "addremove": (addremove, [], "hg addremove"),
     "ann|annotate": (annotate,
                      [('r', 'revision', '', 'revision'),
                       ('u', 'user', None, 'show user'),
                       ('n', 'number', None, 'show revision number'),
                       ('c', 'changeset', None, 'show changeset')],
                      'hg annotate [-u] [-c] [-n] [-r id] [files]'),
     "cat|dump": (cat, [], 'hg cat <file> [rev]'),
     "commit|ci": (commit,
                   [('t', 'text', "", 'commit text'),
                    ('l', 'logfile', "", 'commit text file')],
                   'hg commit [files]'),
     "debugaddchangegroup": (debugaddchangegroup, [], 'debugaddchangegroup'),
     "debugchangegroup": (debugchangegroup, [], 'debugchangegroup [roots]'),
     "debugindex": (debugindex, [], 'debugindex <file>'),
     "debugindexdot": (debugindexdot, [], 'debugindexdot <file>'),
     "diff": (diff, [('r', 'rev', [], 'revision')],
              'hg diff [-r A] [-r B] [files]'),
     "export": (export, [], "hg export <changeset>"),
     "forget": (forget, [], "hg forget [files]"),
     "heads": (heads, [], 'hg heads'),
     "history": (history, [], 'hg history'),
     "help": (help, [], 'hg help [command]'),
     "init": (init, [], 'hg init [url]'),
     "log": (log, [], 'hg log <file>'),
     "manifest|dumpmanifest": (manifest, [], 'hg manifest [rev]'),
     "parents": (parents, [], 'hg parents [node]'),
     "patch|import": (patch,
                      [('p', 'strip', 1, 'path strip'),
                       ('b', 'base', "", 'base path'),
                       ('q', 'quiet', "", 'silence diff')],
                      "hg import [options] patches"),
     "pull|merge": (pull, [], 'hg pull [source]'),
     "rawcommit": (rawcommit,
                   [('p', 'parent', [], 'parent'),
                    ('d', 'date', "", 'data'),
                    ('u', 'user', "", 'user'),
                    ('F', 'files', "", 'file list'),
                    ('t', 'text', "", 'commit text'),
                    ('l', 'logfile', "", 'commit text file')],
                   'hg rawcommit [options] [files]'),
     "recover": (recover, [], "hg recover"),
     "remove": (remove, [], "hg remove [files]"),
     "serve": (serve, [('p', 'port', 8000, 'listen port'),
                       ('a', 'address', '', 'interface address'),
                       ('n', 'name', os.getcwd(), 'repository name'),
                       ('t', 'templates', "", 'template map')],
               "hg serve [options]"),
     "status": (status, [], 'hg status'),
     "tags": (tags, [], 'hg tags'),
     "tip": (tip, [], 'hg tip'),
     "undo": (undo, [], 'hg undo'),
     "update|up|checkout|co|resolve": (update,
                                       [('m', 'merge', None,
                                         'allow merging of conflicts'),
                                        ('C', 'clean', None,
                                         'overwrite locally modified files')],
                                        'hg update [options] [node]'),
     "verify": (verify, [], 'hg verify'),
     }
 
 norepo = "init branch help debugindex debugindexdot"
 
 def find(cmd):
     i = None
     for e in table.keys():
         if re.match(e + "$", cmd):
             return table[e]
 
     raise UnknownCommand(cmd)
 
 class SignalInterrupt(Exception): pass
 
 def catchterm(*args):
     raise SignalInterrupt
 
 def run():
     sys.exit(dispatch(sys.argv[1:]))
 
 def dispatch(args):
     options = {}
     opts = [('v', 'verbose', None, 'verbose'),
             ('d', 'debug', None, 'debug'),
             ('q', 'quiet', None, 'quiet'),
             ('y', 'noninteractive', None, 'run non-interactively'),
             ]
 
     args = fancyopts.fancyopts(args, opts, options,
                                'hg [options] <command> [options] [files]')
 
     if not args:
         cmd = "help"
     else:
         cmd, args = args[0], args[1:]
 
     u = ui.ui(options["verbose"], options["debug"], options["quiet"],
            not options["noninteractive"])
 
     try:
         i = find(cmd)
     except UnknownCommand:
         u.warn("hg: unknown command '%s'\n" % cmd)
         help(u)
         sys.exit(1)
 
     signal.signal(signal.SIGTERM, catchterm)
 
     cmdoptions = {}
-    args = fancyopts.fancyopts(args, i[1], cmdoptions, i[2])
+    try:
+        args = fancyopts.fancyopts(args, i[1], cmdoptions, i[2])
+    except fancyopts.getopt.GetoptError, inst:
+        u.warn("hg %s: %s\n" % (cmd, inst))
+        help(u, cmd)
+        sys.exit(-1)
 
     if cmd not in norepo.split():
         repo = hg.repository(ui = u)
         d = lambda: i[0](u, repo, *args, **cmdoptions)
     else:
         d = lambda: i[0](u, *args, **cmdoptions)
 
     try:
         return d()
     except SignalInterrupt:
         u.warn("killed!\n")
     except KeyboardInterrupt:
         u.warn("interrupted!\n")
     except IOError, inst:
         if inst.errno == 32:
             u.warn("broken pipe\n")
         else:
             raise
     except TypeError, inst:
         # was this an argument error?
         tb = traceback.extract_tb(sys.exc_info()[2])
         if len(tb) > 2: # no
             raise
-        raise
+        u.debug(inst, "\n")
         u.warn("%s: invalid arguments\n" % i[0].__name__)
-        u.warn("syntax: %s\n" % i[2])
+        help(u, cmd)
         sys.exit(-1)
+

mercurial/fancyopts.py

@@ -1,53 +1,30 b''
 import sys, os, getopt
 
 def fancyopts(args, options, state, syntax='', minlen = 0):
     long=[]
     short=''
     map={}
     dt={}
 
-    def help(state, opt, arg, options=options, syntax=syntax):
-        print "Usage: ", syntax
-
-        for s, l, d, c in options:
-            opt=' '
-            if s: opt = opt + '-' + s + ' '
-            if l: opt = opt + '--' + l + ' '
-            if d: opt = opt + '(' + str(d) + ')'
-            print opt
-            if c: print '   %s' % c
-        sys.exit(0)
-
-    if len(args) < minlen:
-        help(state, None, args)
-
-    options=[('h', 'help', help, 'Show usage info')] + options
-    
     for s, l, d, c in options:
         map['-'+s] = map['--'+l]=l
         state[l] = d
         dt[l] = type(d)
-        if not d is None and not type(d) is type(help): s, l=s+':', l+'='      
+        if not d is None and not callable(d): s, l=s+':', l+'='      
         if s: short = short + s
         if l: long.append(l)
 
     if os.environ.has_key("HG_OPTS"):
         args = os.environ["HG_OPTS"].split() + args
 
-    try:
-        opts, args = getopt.getopt(args, short, long)
-    except getopt.GetoptError:
-        help(state, None, args)
-        sys.exit(-1)
+    opts, args = getopt.getopt(args, short, long)
 
     for opt, arg in opts:
-        if dt[map[opt]] is type(help): state[map[opt]](state,map[opt],arg)
+        if dt[map[opt]] is type(fancyopts): state[map[opt]](state,map[opt],arg)
         elif dt[map[opt]] is type(1): state[map[opt]] = int(arg)
         elif dt[map[opt]] is type(''): state[map[opt]] = arg
         elif dt[map[opt]] is type([]): state[map[opt]].append(arg)
         elif dt[map[opt]] is type(None): state[map[opt]] = 1
 
-    del state["help"]
-
     return args