view doc/gendoc.py @ 5192:33015dac5df5

convert: fix mercurial_sink.putcommit Changeset 4ebc8693ce72 added some code to putcommit to avoid creating a revision that touches no files, but this can break regular conversions from some repositories: - conceptually, since we're converting a repo, we should try to make the new hg repo as similar as possible to the original repo - we should create a new changeset, even if the original revision didn't touch any files (maybe the commit message had some important bit); - even if a "regular" revision that doesn't touch any file may seem weird (and maybe even broken), it's completely legitimate for a merge revision to not touch any file, and, if we just skip it, the converted repo will end up with wrong history and possibly an extra head. As an example, say the crew and main hg repos are sync'ed. Somebody sends an important patch to the mailing list. Matt quickly applies and pushes it. But at the same time somebody also applies it to crew and pushes it. Suppose the commit message ended up being a bit different (say, there was a typo and somebody didn't fix it) or that the date ended up being different (because of different patch-applying scripts): the changeset hashes will be different, but the manifests will be the same. Since both changesets were pushed to public repos, it's hard to recall them. If both are merged, the manifest from the resulting merge revision will have the exact same contents as its parents - i.e. the merge revision really doesn't touch any file at all. To keep the file filtering stuff "working", the generic code was changed to skip empty revisions if we're filtering the repo, fixing a bug in the process (we want parents[0] instead of tip).
author Alexis S. L. Carvalho <alexis@cecm.usp.br>
date Fri, 17 Aug 2007 20:18:05 -0300
parents 54fd4d3b4fce
children bbdcdc7f170e
line wrap: on
line source

import sys, textwrap
# import from the live mercurial repo
sys.path.insert(0, "..")
from mercurial.commands import table, globalopts
from mercurial.i18n import gettext as _
from mercurial.help import helptable

def get_desc(docstr):
    if not docstr:
        return "", ""
    # sanitize
    docstr = docstr.strip("\n")
    docstr = docstr.rstrip()
    shortdesc = docstr.splitlines()[0].strip()

    i = docstr.find("\n")
    if i != -1:
        desc = docstr[i+2:]
    else:
        desc = "    %s" % shortdesc
    return (shortdesc, desc)

def get_opts(opts):
    for shortopt, longopt, default, desc in opts:
        allopts = []
        if shortopt:
            allopts.append("-%s" % shortopt)
        if longopt:
            allopts.append("--%s" % longopt)
        desc += default and _(" (default: %s)") % default or ""
        yield(", ".join(allopts), desc)

def get_cmd(cmd):
    d = {}
    attr = table[cmd]
    cmds = cmd.lstrip("^").split("|")

    d['synopsis'] = attr[2]
    d['cmd'] = cmds[0]
    d['aliases'] = cmd.split("|")[1:]
    d['desc'] = get_desc(attr[0].__doc__)
    d['opts'] = list(get_opts(attr[1]))
    return d


def show_doc(ui):
    def bold(s, text=""):
        ui.write("%s\n%s\n%s\n" % (s, "="*len(s), text))
    def underlined(s, text=""):
        ui.write("%s\n%s\n%s\n" % (s, "-"*len(s), text))

    # print options
    underlined(_("OPTIONS"))
    for optstr, desc in get_opts(globalopts):
        ui.write("%s::\n    %s\n\n" % (optstr, desc))

    # print cmds
    underlined(_("COMMANDS"))
    h = {}
    for c, attr in table.items():
            f = c.split("|")[0]
            f = f.lstrip("^")
            h[f] = c
    cmds = h.keys()
    cmds.sort()

    for f in cmds:
            if f.startswith("debug"): continue
            d = get_cmd(h[f])
            # synopsis
            ui.write("%s::\n" % d['synopsis'].replace("hg ","", 1))
            # description
            ui.write("%s\n\n" % d['desc'][1])
            # options
            opt_output = list(d['opts'])
            if opt_output:
                opts_len = max([len(line[0]) for line in opt_output])
                ui.write(_("    options:\n"))
                for optstr, desc in opt_output:
                    if desc:
                        s = "%-*s  %s" % (opts_len, optstr, desc)
                    else:
                        s = optstr
                    s = textwrap.fill(s, initial_indent=4 * " ",
                                      subsequent_indent=(6 + opts_len) * " ")
                    ui.write("%s\n" % s)
                ui.write("\n")
            # aliases
            if d['aliases']:
                ui.write(_("    aliases: %s\n\n") % " ".join(d['aliases']))

    # print topics
    for t in helptable:
        l = t.split("|")
        section = l[-1]
        underlined(_(section).upper())
        doc = helptable[t]
        if callable(doc):
            doc = doc()
        ui.write(_(doc))
        ui.write("\n")

if __name__ == "__main__":
    show_doc(sys.stdout)