Patchwork [1,of,6] convert: add initial docs for git sources

login
register
mail settings
Submitter Siddharth Agarwal
Date Sept. 12, 2014, 7:48 p.m.
Message ID <8010fe5fc2651dd75a2c.1410551312@devbig136.prn2.facebook.com>
Download mbox | patch
Permalink /patch/5806/
State Accepted
Headers show

Comments

Siddharth Agarwal - Sept. 12, 2014, 7:48 p.m.
# HG changeset patch
# User Siddharth Agarwal <sid0@fb.com>
# Date 1410542276 25200
#      Fri Sep 12 10:17:56 2014 -0700
# Node ID 8010fe5fc2651dd75a2c7849af0ef7870a3b7a6f
# Parent  ca854cd4a26a8770fbc22b4d7ee1ac6823b682a5
convert: add initial docs for git sources

Upcoming patches will add config options for git sources. This patch adds a
place to document them.

Patch

diff --git a/hgext/convert/__init__.py b/hgext/convert/__init__.py
--- a/hgext/convert/__init__.py
+++ b/hgext/convert/__init__.py
@@ -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
     ###############
 
diff --git a/tests/test-convert.t b/tests/test-convert.t
--- a/tests/test-convert.t
+++ b/tests/test-convert.t
@@ -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
       ###############