Mercurial > hg
comparison hgext/convert/__init__.py @ 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 | 0079fb98e8d0 |
comparison
equal
deleted
inserted
replaced
12923:7d384a372ce8 | 12924:2f1174b2c4fa |
---|---|
57 --branchsort. | 57 --branchsort. |
58 | 58 |
59 --sourcesort try to preserve source revisions order, only | 59 --sourcesort try to preserve source revisions order, only |
60 supported by Mercurial sources. | 60 supported by Mercurial sources. |
61 | 61 |
62 If <REVMAP> isn't given, it will be put in a default location | 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 | 63 (``<dest>/.hg/shamap`` by default). The ``REVMAP`` is a simple |
64 that maps each source commit ID to the destination ID for that | 64 text file that maps each source commit ID to the destination ID |
65 revision, like so:: | 65 for that revision, like so:: |
66 | 66 |
67 <source ID> <destination ID> | 67 <source ID> <destination ID> |
68 | 68 |
69 If the file doesn't exist, it's automatically created. It's | 69 If the file doesn't exist, it's automatically created. It's |
70 updated on each commit copied, so :hg:`convert` can be interrupted | 70 updated on each commit copied, so :hg:`convert` can be interrupted |
156 '''''''''' | 156 '''''''''' |
157 | 157 |
158 CVS source will use a sandbox (i.e. a checked-out copy) from CVS | 158 CVS source will use a sandbox (i.e. a checked-out copy) from CVS |
159 to indicate the starting point of what will be converted. Direct | 159 to indicate the starting point of what will be converted. Direct |
160 access to the repository files is not needed, unless of course the | 160 access to the repository files is not needed, unless of course the |
161 repository is :local:. The conversion uses the top level directory | 161 repository is ``:local:``. The conversion uses the top level |
162 in the sandbox to find the CVS repository, and then uses CVS rlog | 162 directory in the sandbox to find the CVS repository, and then uses |
163 commands to find files to convert. This means that unless a | 163 CVS rlog commands to find files to convert. This means that unless |
164 filemap is given, all files under the starting directory will be | 164 a filemap is given, all files under the starting directory will be |
165 converted, and that any directory reorganization in the CVS | 165 converted, and that any directory reorganization in the CVS |
166 sandbox is ignored. | 166 sandbox is ignored. |
167 | 167 |
168 The following options can be used with ``--config``: | 168 The following options can be used with ``--config``: |
169 | 169 |
206 | 206 |
207 Subversion Source | 207 Subversion Source |
208 ''''''''''''''''' | 208 ''''''''''''''''' |
209 | 209 |
210 Subversion source detects classical trunk/branches/tags layouts. | 210 Subversion source detects classical trunk/branches/tags layouts. |
211 By default, the supplied "svn://repo/path/" source URL is | 211 By default, the supplied ``svn://repo/path/`` source URL is |
212 converted as a single branch. If "svn://repo/path/trunk" exists it | 212 converted as a single branch. If ``svn://repo/path/trunk`` exists |
213 replaces the default branch. If "svn://repo/path/branches" exists, | 213 it replaces the default branch. If ``svn://repo/path/branches`` |
214 its subdirectories are listed as possible branches. If | 214 exists, its subdirectories are listed as possible branches. If |
215 "svn://repo/path/tags" exists, it is looked for tags referencing | 215 ``svn://repo/path/tags`` exists, it is looked for tags referencing |
216 converted branches. Default "trunk", "branches" and "tags" values | 216 converted branches. Default ``trunk``, ``branches`` and ``tags`` |
217 can be overridden with following options. Set them to paths | 217 values can be overridden with following options. Set them to paths |
218 relative to the source URL, or leave them blank to disable auto | 218 relative to the source URL, or leave them blank to disable auto |
219 detection. | 219 detection. |
220 | 220 |
221 The following options can be set with ``--config``: | 221 The following options can be set with ``--config``: |
222 | 222 |
223 :convert.svn.branches: specify the directory containing branches. | 223 :convert.svn.branches: specify the directory containing branches. |
224 The defaults is branches. | 224 The defaults is ``branches``. |
225 | 225 |
226 :convert.svn.tags: specify the directory containing tags. The | 226 :convert.svn.tags: specify the directory containing tags. The |
227 default is tags. | 227 default is ``tags``. |
228 | 228 |
229 :convert.svn.trunk: specify the name of the trunk branch The | 229 :convert.svn.trunk: specify the name of the trunk branch The |
230 defauls is trunk. | 230 defauls is ``trunk``. |
231 | 231 |
232 Source history can be retrieved starting at a specific revision, | 232 Source history can be retrieved starting at a specific revision, |
233 instead of being integrally converted. Only single branch | 233 instead of being integrally converted. Only single branch |
234 conversions are supported. | 234 conversions are supported. |
235 | 235 |
242 The Perforce (P4) importer can be given a p4 depot path or a | 242 The Perforce (P4) importer can be given a p4 depot path or a |
243 client specification as source. It will convert all files in the | 243 client specification as source. It will convert all files in the |
244 source to a flat Mercurial repository, ignoring labels, branches | 244 source to a flat Mercurial repository, ignoring labels, branches |
245 and integrations. Note that when a depot path is given you then | 245 and integrations. Note that when a depot path is given you then |
246 usually should specify a target directory, because otherwise the | 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 It is possible to limit the amount of source history to be | 249 It is possible to limit the amount of source history to be |
250 converted by specifying an initial Perforce revision: | 250 converted by specifying an initial Perforce revision: |
251 | 251 |
252 :convert.p4.startrev: specify initial Perforce revision, a | 252 :convert.p4.startrev: specify initial Perforce revision, a |