nicer and round-trippable mapping of git ref names to bzr branch names

1 files changed, 11 insertions, 3 deletions

diff --git a/__init__.py b/__init__.py
index d9e9e85..a45535e 100644
--- a/__init__.py
+++ b/__init__.py
@@ -104,13 +104,21 @@ class cmd_fast_import(Command):
     if any, are created in sister directories. If run inside
     a standalone tree, the current branch is also made the
     trunk, but warnings are output about other branches found.
-    
+
+    Git reference names are mapped to bzr branch names as follows:
+      
+    * refs/heads/foo is mapped to foo
+    * refs/remotes/origin/foo is mapped to foo.remote
+    * refs/tags/foo is mapped to foo.tag
+    * */master is mapped to trunk, trunk.remote, etc.
+    * */trunk is mapped to git-trunk, git-trunk.remote, etc.
+
     The stream format is upwardly compatible with git-fast-import
     so existing front-ends for that tool can typically be reused
     without changes. See http://bazaar-vcs.org/BzrFastImport for
     links to matching exporters from Subversion, CVS, Git,
     Mercurial, Darcs, Perforce and SCCS.
- 
+
     While reusing an existing format with existing frontends is
     great, it does mean a slightly more complex recipe when
     importing large projects via exporters that reuse blob data
@@ -124,7 +132,7 @@ class cmd_fast_import(Command):
     In this scenario, the xxx.cfg file generated by the first pass
     holds caching hints that the second pass uses to lower memory
     usage.
-    
+
     At checkpoints and on completion, the commit-id -> revision-id
     map is saved to a file called 'fastimport-id-map' in the control
     directory for the repository (e.g. .bzr/repository). If the import