# HG changeset patch
# User Siddharth Agarwal <sid0@fb.com>
# Date 2014-09-12 17:17:56
# Node ID e1b68c0a936388c7ffbf10d3fd9530c69722614e
# Parent  f8e2aebbb24cf94b97e1a91ec4bbc1d07a9cfe65

convert: add initial docs for git sources

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

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 @@ def convert(ui, src, dest=None, revmapfi
     :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
       ###############