Mercurial > hg
changeset 12924:2f1174b2c4fa
convert: better ReST markup in docstring
| author | Martin Geisler <mg@aragost.com> |
|---|---|
| date | Thu, 04 Nov 2010 18:19:10 +0100 |
| parents | 7d384a372ce8 |
| children | 6eab8f0df2ca |
| files | hgext/convert/__init__.py tests/test-convert.t |
| diffstat | 2 files changed, 26 insertions(+), 26 deletions(-) [+] |
line wrap: on
line diff
--- a/hgext/convert/__init__.py Thu Nov 04 18:11:10 2010 +0100 +++ b/hgext/convert/__init__.py Thu Nov 04 18:19:10 2010 +0100 @@ -59,10 +59,10 @@ --sourcesort try to preserve source revisions order, only supported by Mercurial sources. - If <REVMAP> isn't given, it will be put in a default location - (<dest>/.hg/shamap by default). The <REVMAP> is a simple text file - that maps each source commit ID to the destination ID for that - revision, like so:: + If ``REVMAP`` isn't given, it will be put in a default location + (``<dest>/.hg/shamap`` by default). The ``REVMAP`` is a simple + text file that maps each source commit ID to the destination ID + for that revision, like so:: <source ID> <destination ID> @@ -158,10 +158,10 @@ CVS source will use a sandbox (i.e. a checked-out copy) from CVS to indicate the starting point of what will be converted. Direct access to the repository files is not needed, unless of course the - repository is :local:. The conversion uses the top level directory - in the sandbox to find the CVS repository, and then uses CVS rlog - commands to find files to convert. This means that unless a - filemap is given, all files under the starting directory will be + repository is ``:local:``. The conversion uses the top level + directory in the sandbox to find the CVS repository, and then uses + CVS rlog commands to find files to convert. This means that unless + a filemap is given, all files under the starting directory will be converted, and that any directory reorganization in the CVS sandbox is ignored. @@ -208,26 +208,26 @@ ''''''''''''''''' Subversion source detects classical trunk/branches/tags layouts. - By default, the supplied "svn://repo/path/" source URL is - converted as a single branch. If "svn://repo/path/trunk" exists it - replaces the default branch. If "svn://repo/path/branches" exists, - its subdirectories are listed as possible branches. If - "svn://repo/path/tags" exists, it is looked for tags referencing - converted branches. Default "trunk", "branches" and "tags" values - can be overridden with following options. Set them to paths + By default, the supplied ``svn://repo/path/`` source URL is + converted as a single branch. If ``svn://repo/path/trunk`` exists + it replaces the default branch. If ``svn://repo/path/branches`` + exists, its subdirectories are listed as possible branches. If + ``svn://repo/path/tags`` exists, it is looked for tags referencing + converted branches. Default ``trunk``, ``branches`` and ``tags`` + values can be overridden with following options. Set them to paths relative to the source URL, or leave them blank to disable auto detection. The following options can be set with ``--config``: :convert.svn.branches: specify the directory containing branches. - The defaults is branches. + The defaults is ``branches``. :convert.svn.tags: specify the directory containing tags. The - default is tags. + default is ``tags``. :convert.svn.trunk: specify the name of the trunk branch The - defauls is trunk. + defauls is ``trunk``. Source history can be retrieved starting at a specific revision, instead of being integrally converted. Only single branch @@ -244,7 +244,7 @@ source to a flat Mercurial repository, ignoring labels, branches and integrations. Note that when a depot path is given you then usually should specify a target directory, because otherwise the - target may be named ...-hg. + target may be named ``...-hg``. It is possible to limit the amount of source history to be converted by specifying an initial Perforce revision:
--- a/tests/test-convert.t Thu Nov 04 18:11:10 2010 +0100 +++ b/tests/test-convert.t Thu Nov 04 18:19:10 2010 +0100 @@ -48,8 +48,8 @@ --sourcesort try to preserve source revisions order, only supported by Mercurial sources. - If <REVMAP> isn't given, it will be put in a default location - (<dest>/.hg/shamap by default). The <REVMAP> is a simple text file that + If "REVMAP" isn't given, it will be put in a default location + ("<dest>/.hg/shamap" by default). The "REVMAP" is a simple text file that maps each source commit ID to the destination ID for that revision, like so: @@ -143,7 +143,7 @@ CVS source will use a sandbox (i.e. a checked-out copy) from CVS to indicate the starting point of what will be converted. Direct access to the repository files is not needed, unless of course the repository is - :local:. The conversion uses the top level directory in the sandbox to + ":local:". The conversion uses the top level directory in the sandbox to find the CVS repository, and then uses CVS rlog commands to find files to convert. This means that unless a filemap is given, all files under the starting directory will be converted, and that any directory @@ -205,11 +205,11 @@ convert.svn.branches specify the directory containing branches. The defaults is - branches. + "branches". convert.svn.tags - specify the directory containing tags. The default is tags. + specify the directory containing tags. The default is "tags". convert.svn.trunk - specify the name of the trunk branch The defauls is trunk. + specify the name of the trunk branch The defauls is "trunk". Source history can be retrieved starting at a specific revision, instead of being integrally converted. Only single branch conversions are @@ -225,7 +225,7 @@ specification as source. It will convert all files in the source to a flat Mercurial repository, ignoring labels, branches and integrations. Note that when a depot path is given you then usually should specify a target - directory, because otherwise the target may be named ...-hg. + directory, because otherwise the target may be named "...-hg". It is possible to limit the amount of source history to be converted by specifying an initial Perforce revision: