git-svnimport: -r adds svn revision number to commit messages
[git.git] / Documentation / git-cvsimport.txt
index 88bd3b0..dfe86ce 100644 (file)
@@ -8,10 +8,10 @@ git-cvsimport - Import a CVS repository into git
 
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------
-'git-cvsimport' [ -o <branch-for-HEAD> ] [ -h ] [ -v ]
-                       [ -d <CVSROOT> ] [ -p <options-for-cvsps> ]
-                       [ -C <git_repository> ] [ -i ] [ -P <file> ] [ -k ]
-                       [ -s <subst> ] [ -m ] [ -M regex ] [ <CVS_module> ]
+[verse]
+'git-cvsimport' [-o <branch-for-HEAD>] [-h] [-v] [-d <CVSROOT>] [-s <subst>]
+             [-p <options-for-cvsps>] [-C <git_repository>] [-i] [-P <file>]
+             [-m] [-M regex] [<CVS_module>]
 
 
 DESCRIPTION
 
 
 DESCRIPTION
@@ -60,7 +60,7 @@ the old cvs2git tool.
 +
 If you need to pass multiple options, separate them with a comma.
 
 +
 If you need to pass multiple options, separate them with a comma.
 
--P:: <cvsps-output-file>
+-P <cvsps-output-file>::
        Instead of calling cvsps, read the provided cvsps output file. Useful
        for debugging or when cvsps is being handled outside cvsimport.
 
        Instead of calling cvsps, read the provided cvsps output file. Useful
        for debugging or when cvsps is being handled outside cvsimport.
 
@@ -89,6 +89,26 @@ If you need to pass multiple options, separate them with a comma.
 -s <subst>::
        Substitute the character "/" in branch names with <subst>
 
 -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.
 OUTPUT
 ------
 If '-v' is specified, the script reports what it is doing.