convert: improve subversion source documentation
authorPatrick Mezard <pmezard@gmail.com>
Sat, 23 Feb 2008 16:43:33 +0100
changeset 6169 55455556f921
parent 6168 2ab54f48dbe8
child 6170 747169c54c68
convert: improve subversion source documentation
hgext/convert/__init__.py
--- a/hgext/convert/__init__.py	Sat Feb 23 11:19:59 2008 +0100
+++ b/hgext/convert/__init__.py	Sat Feb 23 16:43:33 2008 +0100
@@ -78,23 +78,42 @@
     IDs (in either the source or destination revision control system)
     that should be used as the new parents for that node.
 
-    Back end options:
+    Mercurial Source
+    -----------------
+
+    --config convert.hg.saverev=True          (boolean)
+        allow target to preserve source revision ID
+
+    Subversion Source
+    -----------------
+
+    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 overriden with following options. Set them to paths
+    relative to the source URL.
+
+    --config convert.svn.branches=branches    (directory name)
+        specify the directory containing branches
+    --config convert.svn.tags=tags            (directory name)
+        specify the directory containing tags
+    --config convert.svn.trunk=trunk          (directory name)
+        specify the name of the trunk branch
+
+    Mercurial Destination
+    ---------------------
 
     --config convert.hg.clonebranches=False   (boolean)
-        hg target: XXX not documented
-    --config convert.hg.saverev=True          (boolean)
-        hg source: allow target to preserve source revision ID
+        dispatch source branches in separate clones.
     --config convert.hg.tagsbranch=default    (branch name)
-        hg target: XXX not documented
+        tag revisions branch name
     --config convert.hg.usebranchnames=True   (boolean)
-        hg target: preserve branch names
+        preserve branch names
 
-    --config convert.svn.branches=branches    (directory name)
-        svn source: specify the directory containing branches
-    --config convert.svn.tags=tags            (directory name)
-        svn source: specify the directory containing tags
-    --config convert.svn.trunk=trunk          (directory name)
-        svn source: specify the name of the trunk branch
     """
     return convcmd.convert(ui, src, dest, revmapfile, **opts)