Commit 595ec3c3 authored by Martin Geisler's avatar Martin Geisler
Browse files

commands: use field lists instead of literal blocks in docstrings

The literal blocks were mis-used for alignment, but this of course
changes the font of the entire block to a fixed width font in the HTML
version. Using a proper list solves this.

--HG--
branch : stable
parent 5c5a08d6f85d
...@@ -141,14 +141,14 @@ def archive(ui, repo, dest, **opts): ...@@ -141,14 +141,14 @@ def archive(ui, repo, dest, **opts):
directory; use -r/--rev to specify a different revision. directory; use -r/--rev to specify a different revision.
To specify the type of archive to create, use -t/--type. Valid To specify the type of archive to create, use -t/--type. Valid
types are:: types are:
"files" (default): a directory full of files :``files``: a directory full of files (default)
"tar": tar archive, uncompressed :``tar``: tar archive, uncompressed
"tbz2": tar archive, compressed using bzip2 :``tbz2``: tar archive, compressed using bzip2
"tgz": tar archive, compressed using gzip :``tgz``: tar archive, compressed using gzip
"uzip": zip archive, uncompressed :``uzip``: zip archive, uncompressed
"zip": zip archive, compressed using deflate :``zip``: zip archive, compressed using deflate
The exact name of the destination archive or directory is given The exact name of the destination archive or directory is given
using a format string; see 'hg help export' for details. using a format string; see 'hg help export' for details.
...@@ -561,11 +561,11 @@ def cat(ui, repo, file1, *pats, **opts): ...@@ -561,11 +561,11 @@ def cat(ui, repo, file1, *pats, **opts):
Output may be to a file, in which case the name of the file is 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 given using a format string. The formatting rules are the same as
for the export command, with the following additions:: for the export command, with the following additions:
%s basename of file being printed :``%s``: basename of file being printed
%d dirname of file being printed, or '.' if in repository root :``%d``: dirname of file being printed, or '.' if in repository root
%p root-relative path name of file being printed :``%p``: root-relative path name of file being printed
""" """
ctx = repo[opts.get('rev')] ctx = repo[opts.get('rev')]
err = 1 err = 1
...@@ -1140,16 +1140,16 @@ def export(ui, repo, *changesets, **opts): ...@@ -1140,16 +1140,16 @@ def export(ui, repo, *changesets, **opts):
first parent only. first parent only.
Output may be to a file, in which case the name of the file is 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:: given using a format string. The formatting rules are as follows:
%% literal "%" character :``%%``: literal "%" character
%H changeset hash (40 bytes of hexadecimal) :``%H``: changeset hash (40 bytes of hexadecimal)
%N number of patches being generated :``%N``: number of patches being generated
%R changeset revision number :``%R``: changeset revision number
%b basename of the exporting repository :``%b``: basename of the exporting repository
%h short-form changeset hash (12 bytes of hexadecimal) :``%h``: short-form changeset hash (12 bytes of hexadecimal)
%n zero-padded sequence number, starting at 1 :``%n``: zero-padded sequence number, starting at 1
%r zero-padded changeset revision number :``%r``: zero-padded changeset revision number
Without the -a/--text option, export will avoid generating diffs Without the -a/--text option, export will avoid generating diffs
of files it detects as binary. With -a, export will generate a of files it detects as binary. With -a, export will generate a
......
...@@ -13,9 +13,9 @@ output the current or given revision of files ...@@ -13,9 +13,9 @@ output the current or given revision of files
a format string. The formatting rules are the same as for the export 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 "%s" basename of file being printed
%d dirname of file being printed, or '.' if in repository root "%d" dirname of file being printed, or '.' if in repository root
%p root-relative path name of file being printed "%p" root-relative path name of file being printed
options: options:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment