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

comparison mercurial/commands.py @ 9157:9261667e9b82

commands: use minirst parser when displaying help

author	Martin Geisler <mg@lazybytes.net>
date	Thu, 16 Jul 2009 23:25:26 +0200
parents	63cfacb7917e
children	07d127e771a1

comparison

equal deleted inserted replaced

-:c9c7e8cdac9c
+:9261667e9b82
 import hg, util, revlog, bundlerepo, extensions, copies, context, error
 import patch, help, mdiff, url, encoding
 import archival, changegroup, cmdutil, sshserver, hbisect
 from hgweb import server
 import merge as merge_
+import minirst
 # Commands start here, listed alphabetically
 def add(ui, repo, *pats, **opts):
 """add the specified files on the next commit
 '''create an unversioned archive of a repository revision
 By default, the revision used is the parent of the working directory; use
 -r/--rev to specify a different revision.
-To specify the type of archive to create, use -t/--type. Valid types are:
+To specify the type of archive to create, use -t/--type. Valid types are::
 "files" (default): a directory full of files
 "tar": tar archive, uncompressed
 "tbz2": tar archive, compressed using bzip2
 "tgz": tar archive, compressed using gzip
 "uzip": zip archive, uncompressed
 "zip": zip archive, compressed using deflate
 The exact name of the destination archive or directory is given using a
 format string; see 'hg help export' for details.
 Each member added to an archive file has a directory prefix prepended. Use
 revision is given, the parent of the working directory is used, or tip if
 no revision is checked out.
 Output may be to a file, in which case the name of the file is given using
 a format string. The formatting rules are the same as for the export
-command, with the following additions:
+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
 """
 ctx = repo[opts.get('rev')]
 err = 1
 m = cmdutil.match(repo, (file1,) + pats, opts)
 for abs in ctx.walk(m):
 repository data, not to the checked out files). Some filesystems, such as
 AFS, implement hardlinking incorrectly, but do not report errors. In these
 cases, use the --pull option to avoid hardlinking.
 In some cases, you can clone repositories and checked out files using full
-hardlinks with
+hardlinks with ::
 $ cp -al REPO REPOCLONE
 This is the fastest way to clone, but it is not always safe. The operation
 is not atomic (making sure REPO is not modified during the operation is up
 NOTE: export may generate unexpected diff output for merge changesets, as
 it will compare the merge changeset against its first parent only.
 Output may be to a file, in which case the name of the file is given using
-a format string. The formatting rules are as follows:
+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/--text option, export will avoid generating diffs of files
 it detects as binary. With -a, export will generate a diff anyway,
 probably with undesirable results.
 With no arguments, print a list of commands with short help messages.
 Given a topic, extension, or command name, print help for that topic.
 """
 option_lists = []
+textwidth = util.termwidth() - 2
 def addglobalopts(aliases):
 if ui.verbose:
 option_lists.append((_("global options:"), globalopts))
 if name == 'shortlist':
 doc = gettext(i[0].__doc__)
 if not doc:
 doc = _("(no help text available)")
 if ui.quiet:
 doc = doc.splitlines()[0]
-ui.write("\n%s\n" % doc.rstrip())
+ui.write("\n%s\n" % minirst.format(doc, textwidth))
 if not ui.quiet:
 # options
 if i[1]:
 option_lists.append((_("options:\n"), i[1]))
 else:
 ui.write(' %-*s   %s\n' % (m, f, util.wrap(h[f], m + 4)))
 if name != 'shortlist':
 exts, maxlength = extensions.enabled()
-ui.write(help.listexts(_('enabled extensions:'), exts, maxlength))
+text = help.listexts(_('enabled extensions:'), exts, maxlength)
+if text:
+ui.write("\n%s\n" % minirst.format(text, textwidth))
 if not ui.quiet:
 addglobalopts(True)
 def helptopic(name):
 if not doc:
 doc = _("(no help text available)")
 if hasattr(doc, '__call__'):
 doc = doc()
-ui.write("%s\n" % header)
+ui.write("%s\n\n" % header)
-ui.write("%s\n" % doc.rstrip())
+ui.write("%s\n" % minirst.format(doc, textwidth))
 def helpext(name):
 try:
 mod = extensions.find(name)
 except KeyError:
 raise error.UnknownCommand(name)
 doc = gettext(mod.__doc__) or _('no help text available')
-doc = doc.splitlines()
+head, tail = doc.split('\n', 1)
-ui.write(_('%s extension - %s\n') % (name.split('.')[-1], doc[0]))
+ui.write(_('%s extension - %s\n\n') % (name.split('.')[-1], head))
-for d in doc[1:]:
+if tail:
-ui.write(d, '\n')
+ui.write(minirst.format(tail, textwidth))
+ui.status('\n\n')
-ui.status('\n')
 try:
 ct = mod.cmdtable
 except AttributeError:
 ct = {}
 from the working directory.
 The following table details the behavior of remove for different file
 states (columns) and option combinations (rows). The file states are Added
 [A], Clean [C], Modified [M] and Missing [!] (as reported by hg status).
-The actions are Warn, Remove (from branch) and Delete (from disk).
+The actions are Warn, Remove (from branch) and Delete (from disk)::
 A  C  M  !
 none   W  RD W  R
 -f     R  RD RD R
 -A     W  W  W  R
 -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.
 """
 This command also allows listing resolved files and manually indicating
 whether or not files are resolved. All files must be marked as resolved
 before a commit is permitted.
-The codes used to show the status of files are:
+The codes used to show the status of files are::
-U = unresolved
-R = resolved
+U = unresolved
+R = resolved
 """
 all, mark, unmark, show = [opts.get(o) for o in 'all mark unmark list'.split()]
 if (show and (mark or unmark)) or (mark and unmark):
 since that time. This command does not alter the working directory.
 Transactions are used to encapsulate the effects of all commands that
 create new changesets or propagate existing changesets into a repository.
 For example, the following commands are transactional, and their effects
-can be rolled back:
+can be rolled back::
 commit
 import
 pull
 push (with this repository as destination)
 parent.
 If one revision is given, it is used as the base revision. If two
 revisions are given, the differences between them are shown.
-The codes used to show the status of files are:
+The codes used to show the status of files are::
-M = modified
-A = added
+M = modified
-R = removed
+A = added
-C = clean
+R = removed
-! = missing (deleted by non-hg command, but still tracked)
+C = clean
-? = not tracked
+! = missing (deleted by non-hg command, but still tracked)
-I = ignored
+? = not tracked
-= origin of the previous file listed as A (added)
+I = ignored
+= origin of the previous file listed as A (added)
 """
 node1, node2 = cmdutil.revpair(repo, opts.get('rev'))
 cwd = (pats and repo.getcwd()) or ''
 end = opts.get('print0') and '\0' or '\n'

Mercurial > public > mercurial-scm > hg

comparison mercurial/commands.py @ 9157:9261667e9b82