convert: add initial docs for git sources
authorSiddharth Agarwal <sid0@fb.com>
Fri, 12 Sep 2014 10:17:56 -0700
changeset 22466 e1b68c0a9363
parent 22465 f8e2aebbb24c
child 22467 333d654783ad
convert: add initial docs for git sources Upcoming patches will add config options for git sources. This patch adds a place to document them.
hgext/convert/__init__.py
tests/test-convert.t
--- a/hgext/convert/__init__.py	Sun Aug 24 17:27:28 2014 -0400
+++ b/hgext/convert/__init__.py	Fri Sep 12 10:17:56 2014 -0700
@@ -282,6 +282,15 @@
     :convert.svn.startrev: specify start Subversion revision number.
         The default is 0.
 
+    Git Source
+    ##########
+
+    The Git importer converts commits from all reachable branches (refs
+    in refs/heads) and remotes (refs in refs/remotes) to Mercurial.
+    Branches are converted to bookmarks with the same name, with the
+    leading 'refs/heads' stripped. Git submodules are converted to Git
+    subrepos in Mercurial.
+
     Perforce Source
     ###############
 
--- a/tests/test-convert.t	Sun Aug 24 17:27:28 2014 -0400
+++ b/tests/test-convert.t	Fri Sep 12 10:17:56 2014 -0700
@@ -236,6 +236,14 @@
       convert.svn.startrev
                     specify start Subversion revision number. The default is 0.
   
+      Git Source
+      ##########
+  
+      The Git importer converts commits from all reachable branches (refs in
+      refs/heads) and remotes (refs in refs/remotes) to Mercurial. Branches are
+      converted to bookmarks with the same name, with the leading 'refs/heads'
+      stripped. Git submodules are converted to Git subrepos in Mercurial.
+  
       Perforce Source
       ###############