##// END OF EJS Templates
convert: better ReST markup in docstring
Martin Geisler -
r12924:2f1174b2 default
parent child Browse files
Show More
@@ -59,10 +59,10 b' def convert(ui, src, dest=None, revmapfi'
59 59 --sourcesort try to preserve source revisions order, only
60 60 supported by Mercurial sources.
61 61
62 If <REVMAP> isn't given, it will be put in a default location
63 (<dest>/.hg/shamap by default). The <REVMAP> is a simple text file
64 that maps each source commit ID to the destination ID for that
65 revision, like so::
62 If ``REVMAP`` isn't given, it will be put in a default location
63 (``<dest>/.hg/shamap`` by default). The ``REVMAP`` is a simple
64 text file that maps each source commit ID to the destination ID
65 for that revision, like so::
66 66
67 67 <source ID> <destination ID>
68 68
@@ -158,10 +158,10 b' def convert(ui, src, dest=None, revmapfi'
158 158 CVS source will use a sandbox (i.e. a checked-out copy) from CVS
159 159 to indicate the starting point of what will be converted. Direct
160 160 access to the repository files is not needed, unless of course the
161 repository is :local:. The conversion uses the top level directory
162 in the sandbox to find the CVS repository, and then uses CVS rlog
163 commands to find files to convert. This means that unless a
164 filemap is given, all files under the starting directory will be
161 repository is ``:local:``. The conversion uses the top level
162 directory in the sandbox to find the CVS repository, and then uses
163 CVS rlog commands to find files to convert. This means that unless
164 a filemap is given, all files under the starting directory will be
165 165 converted, and that any directory reorganization in the CVS
166 166 sandbox is ignored.
167 167
@@ -208,26 +208,26 b' def convert(ui, src, dest=None, revmapfi'
208 208 '''''''''''''''''
209 209
210 210 Subversion source detects classical trunk/branches/tags layouts.
211 By default, the supplied "svn://repo/path/" source URL is
212 converted as a single branch. If "svn://repo/path/trunk" exists it
213 replaces the default branch. If "svn://repo/path/branches" exists,
214 its subdirectories are listed as possible branches. If
215 "svn://repo/path/tags" exists, it is looked for tags referencing
216 converted branches. Default "trunk", "branches" and "tags" values
217 can be overridden with following options. Set them to paths
211 By default, the supplied ``svn://repo/path/`` source URL is
212 converted as a single branch. If ``svn://repo/path/trunk`` exists
213 it replaces the default branch. If ``svn://repo/path/branches``
214 exists, its subdirectories are listed as possible branches. If
215 ``svn://repo/path/tags`` exists, it is looked for tags referencing
216 converted branches. Default ``trunk``, ``branches`` and ``tags``
217 values can be overridden with following options. Set them to paths
218 218 relative to the source URL, or leave them blank to disable auto
219 219 detection.
220 220
221 221 The following options can be set with ``--config``:
222 222
223 223 :convert.svn.branches: specify the directory containing branches.
224 The defaults is branches.
224 The defaults is ``branches``.
225 225
226 226 :convert.svn.tags: specify the directory containing tags. The
227 default is tags.
227 default is ``tags``.
228 228
229 229 :convert.svn.trunk: specify the name of the trunk branch The
230 defauls is trunk.
230 defauls is ``trunk``.
231 231
232 232 Source history can be retrieved starting at a specific revision,
233 233 instead of being integrally converted. Only single branch
@@ -244,7 +244,7 b' def convert(ui, src, dest=None, revmapfi'
244 244 source to a flat Mercurial repository, ignoring labels, branches
245 245 and integrations. Note that when a depot path is given you then
246 246 usually should specify a target directory, because otherwise the
247 target may be named ...-hg.
247 target may be named ``...-hg``.
248 248
249 249 It is possible to limit the amount of source history to be
250 250 converted by specifying an initial Perforce revision:
@@ -48,8 +48,8 b''
48 48 --sourcesort try to preserve source revisions order, only supported by
49 49 Mercurial sources.
50 50
51 If <REVMAP> isn't given, it will be put in a default location
52 (<dest>/.hg/shamap by default). The <REVMAP> is a simple text file that
51 If "REVMAP" isn't given, it will be put in a default location
52 ("<dest>/.hg/shamap" by default). The "REVMAP" is a simple text file that
53 53 maps each source commit ID to the destination ID for that revision, like
54 54 so:
55 55
@@ -143,7 +143,7 b''
143 143 CVS source will use a sandbox (i.e. a checked-out copy) from CVS to
144 144 indicate the starting point of what will be converted. Direct access to
145 145 the repository files is not needed, unless of course the repository is
146 :local:. The conversion uses the top level directory in the sandbox to
146 ":local:". The conversion uses the top level directory in the sandbox to
147 147 find the CVS repository, and then uses CVS rlog commands to find files to
148 148 convert. This means that unless a filemap is given, all files under the
149 149 starting directory will be converted, and that any directory
@@ -205,11 +205,11 b''
205 205
206 206 convert.svn.branches
207 207 specify the directory containing branches. The defaults is
208 branches.
208 "branches".
209 209 convert.svn.tags
210 specify the directory containing tags. The default is tags.
210 specify the directory containing tags. The default is "tags".
211 211 convert.svn.trunk
212 specify the name of the trunk branch The defauls is trunk.
212 specify the name of the trunk branch The defauls is "trunk".
213 213
214 214 Source history can be retrieved starting at a specific revision, instead
215 215 of being integrally converted. Only single branch conversions are
@@ -225,7 +225,7 b''
225 225 specification as source. It will convert all files in the source to a flat
226 226 Mercurial repository, ignoring labels, branches and integrations. Note
227 227 that when a depot path is given you then usually should specify a target
228 directory, because otherwise the target may be named ...-hg.
228 directory, because otherwise the target may be named "...-hg".
229 229
230 230 It is possible to limit the amount of source history to be converted by
231 231 specifying an initial Perforce revision:
General Comments 0
You need to be logged in to leave comments. Login now