Skip to content
Snippets Groups Projects
Commit 2f1174b2c4fa authored by Martin Geisler's avatar Martin Geisler
Browse files

convert: better ReST markup in docstring

parent 7d384a372ce8
No related branches found
No related tags found
No related merge requests found
...@@ -59,10 +59,10 @@ ...@@ -59,10 +59,10 @@
--sourcesort try to preserve source revisions order, only --sourcesort try to preserve source revisions order, only
supported by Mercurial sources. supported by Mercurial sources.
If <REVMAP> isn't given, it will be put in a default location 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 (``<dest>/.hg/shamap`` by default). The ``REVMAP`` is a simple
that maps each source commit ID to the destination ID for that text file that maps each source commit ID to the destination ID
revision, like so:: for that revision, like so::
<source ID> <destination ID> <source ID> <destination ID>
...@@ -158,10 +158,10 @@ ...@@ -158,10 +158,10 @@
CVS source will use a sandbox (i.e. a checked-out copy) from CVS 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 to indicate the starting point of what will be converted. Direct
access to the repository files is not needed, unless of course the access to the repository files is not needed, unless of course the
repository is :local:. The conversion uses the top level directory repository is ``:local:``. The conversion uses the top level
in the sandbox to find the CVS repository, and then uses CVS rlog directory in the sandbox to find the CVS repository, and then uses
commands to find files to convert. This means that unless a CVS rlog commands to find files to convert. This means that unless
filemap is given, all files under the starting directory will be a filemap is given, all files under the starting directory will be
converted, and that any directory reorganization in the CVS converted, and that any directory reorganization in the CVS
sandbox is ignored. sandbox is ignored.
...@@ -208,16 +208,16 @@ ...@@ -208,16 +208,16 @@
''''''''''''''''' '''''''''''''''''
Subversion source detects classical trunk/branches/tags layouts. Subversion source detects classical trunk/branches/tags layouts.
By default, the supplied "svn://repo/path/" source URL is By default, the supplied ``svn://repo/path/`` source URL is
converted as a single branch. If "svn://repo/path/trunk" exists it converted as a single branch. If ``svn://repo/path/trunk`` exists
replaces the default branch. If "svn://repo/path/branches" exists, it replaces the default branch. If ``svn://repo/path/branches``
its subdirectories are listed as possible branches. If exists, its subdirectories are listed as possible branches. If
"svn://repo/path/tags" exists, it is looked for tags referencing ``svn://repo/path/tags`` exists, it is looked for tags referencing
converted branches. Default "trunk", "branches" and "tags" values converted branches. Default ``trunk``, ``branches`` and ``tags``
can be overridden with following options. Set them to paths values can be overridden with following options. Set them to paths
relative to the source URL, or leave them blank to disable auto relative to the source URL, or leave them blank to disable auto
detection. detection.
The following options can be set with ``--config``: The following options can be set with ``--config``:
:convert.svn.branches: specify the directory containing branches. :convert.svn.branches: specify the directory containing branches.
...@@ -218,9 +218,9 @@ ...@@ -218,9 +218,9 @@
relative to the source URL, or leave them blank to disable auto relative to the source URL, or leave them blank to disable auto
detection. detection.
The following options can be set with ``--config``: The following options can be set with ``--config``:
:convert.svn.branches: specify the directory containing branches. :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 :convert.svn.tags: specify the directory containing tags. The
...@@ -225,5 +225,5 @@ ...@@ -225,5 +225,5 @@
:convert.svn.tags: specify the directory containing tags. The :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 :convert.svn.trunk: specify the name of the trunk branch The
...@@ -228,6 +228,6 @@ ...@@ -228,6 +228,6 @@
:convert.svn.trunk: specify the name of the trunk branch The :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, Source history can be retrieved starting at a specific revision,
instead of being integrally converted. Only single branch instead of being integrally converted. Only single branch
...@@ -244,7 +244,7 @@ ...@@ -244,7 +244,7 @@
source to a flat Mercurial repository, ignoring labels, branches source to a flat Mercurial repository, ignoring labels, branches
and integrations. Note that when a depot path is given you then and integrations. Note that when a depot path is given you then
usually should specify a target directory, because otherwise the 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 It is possible to limit the amount of source history to be
converted by specifying an initial Perforce revision: converted by specifying an initial Perforce revision:
......
...@@ -48,8 +48,8 @@ ...@@ -48,8 +48,8 @@
--sourcesort try to preserve source revisions order, only supported by --sourcesort try to preserve source revisions order, only supported by
Mercurial sources. Mercurial sources.
If <REVMAP> isn't given, it will be put in a default location 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 ("<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 maps each source commit ID to the destination ID for that revision, like
so: so:
...@@ -143,7 +143,7 @@ ...@@ -143,7 +143,7 @@
CVS source will use a sandbox (i.e. a checked-out copy) from CVS to 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 indicate the starting point of what will be converted. Direct access to
the repository files is not needed, unless of course the repository is 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 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 convert. This means that unless a filemap is given, all files under the
starting directory will be converted, and that any directory starting directory will be converted, and that any directory
...@@ -205,5 +205,5 @@ ...@@ -205,5 +205,5 @@
convert.svn.branches convert.svn.branches
specify the directory containing branches. The defaults is specify the directory containing branches. The defaults is
branches. "branches".
convert.svn.tags convert.svn.tags
...@@ -209,3 +209,3 @@ ...@@ -209,3 +209,3 @@
convert.svn.tags convert.svn.tags
specify the directory containing tags. The default is tags. specify the directory containing tags. The default is "tags".
convert.svn.trunk convert.svn.trunk
...@@ -211,5 +211,5 @@ ...@@ -211,5 +211,5 @@
convert.svn.trunk 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 Source history can be retrieved starting at a specific revision, instead
of being integrally converted. Only single branch conversions are of being integrally converted. Only single branch conversions are
...@@ -225,7 +225,7 @@ ...@@ -225,7 +225,7 @@
specification as source. It will convert all files in the source to a flat specification as source. It will convert all files in the source to a flat
Mercurial repository, ignoring labels, branches and integrations. Note Mercurial repository, ignoring labels, branches and integrations. Note
that when a depot path is given you then usually should specify a target 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 It is possible to limit the amount of source history to be converted by
specifying an initial Perforce revision: specifying an initial Perforce revision:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment