Merge branch 'jc/empty' into next
[gitweb.git] / Documentation / git-cvsimport.txt
index 01ca7ef96f1040c3260841c13b9c5cdc2e8938dd..57027b448f52a1357d89b569f5b94c8a928f7f56 100644 (file)
@@ -22,6 +22,12 @@ repository, or incrementally import into an existing one.
 Splitting the CVS log into patch sets is done by 'cvsps'.
 At least version 2.1 is required.
 
+You should *never* do any work of your own on the branches that are
+created by git-cvsimport. The initial import will create and populate a
+"master" branch from the CVS repository's main branch which you're free
+to work with; after that, you need to 'git merge' incremental imports, or
+any CVS branches, yourself.
+
 OPTIONS
 -------
 -d <CVSROOT>::
@@ -89,6 +95,26 @@ If you need to pass multiple options, separate them with a comma.
 -s <subst>::
        Substitute the character "/" in branch names with <subst>
 
+-A <author-conv-file>::
+       CVS by default uses the unix username when writing its
+       commit logs. Using this option and an author-conv-file
+       in this format
+
+       exon=Andreas Ericsson <ae@op5.se>
+       spawn=Simon Pawn <spawn@frog-pond.org>
+
+       git-cvsimport will make it appear as those authors had
+       their GIT_AUTHOR_NAME and GIT_AUTHOR_EMAIL set properly
+       all along.
+
+       For convenience, this data is saved to $GIT_DIR/cvs-authors
+       each time the -A option is provided and read from that same
+       file each time git-cvsimport is run.
+
+       It is not recommended to use this feature if you intend to
+       export changes back to CVS again later with
+       git-link[1]::git-cvsexportcommit.
+
 OUTPUT
 ------
 If '-v' is specified, the script reports what it is doing.