[PATCH] Add merge detection to git-cvsimport

[git.git] / Documentation / git-cvsimport-script.txt

diff --git a/Documentation/git-cvsimport-script.txt b/Documentation/git-cvsimport-script.txt
index 05145e9..d01a15d 100644 (file)
--- a/Documentation/git-cvsimport-script.txt
+++ b/Documentation/git-cvsimport-script.txt
@@ -11,7 +11,8 @@ SYNOPSIS
 --------
 'git-cvsimport-script' [ -o <branch-for-HEAD> ] [ -h ] [ -v ]
                        [ -d <CVSROOT> ] [ -p <options-for-cvsps> ]
-                       [ -C <GIT_repository> ] [ -i ] [ <CVS_module> ]
+                       [ -C <GIT_repository> ] [ -i ] [ -k ]
+                       [ -s <subst> ] [ -m ] [ -M regex ] [ <CVS_module> ]
 
 
 DESCRIPTION
@@ -29,11 +30,20 @@ OPTIONS
        currently, only the :local:, :ext: and :pserver: access methods 
        are supported.
 
+-C <target-dir>::
+        The GIT repository to import to.  If the directory doesn't
+        exist, it will be created.  Default is the current directory.
+
 -i::
        Import-only: don't perform a checkout after importing.  This option
        ensures the working directory and cache remain untouched and will
        not create them if they do not exist.
 
+-k::
+       Kill keywords: will extract files with -kk from the CVS archive
+       to avoid noisy changesets. Highly recommended, but off by default
+       to preserve compatibility with early imported trees. 
+
 -o <branch-for-HEAD>::
        The 'HEAD' branch from CVS is imported to the 'origin' branch within
        the git repository, as 'HEAD' already has a special meaning for git.
@@ -44,10 +54,20 @@ OPTIONS
 
 -p <options-for-cvsps>::
        Additional options for cvsps.
-       The options '-x' and '-A' are implicit and should not be used here.
+       The options '-u' and '-A' are implicit and should not be used here.
 
        If you need to pass multiple options, separate them with a comma.
 
+-m::    
+       Attempt to detect merges based on the commit message. This option
+       will enable default regexes that try to capture the name source 
+       branch name from the commit message. 
+
+-M <regex>::
+       Attempt to detect merges based on the commit message with a custom
+       regex. It can be used with -m to also see the default regexes. 
+       You must escape forward slashes. 
+
 -v::
        Verbosity: let 'cvsimport' report what it is doing.
 
@@ -57,6 +77,12 @@ OPTIONS
 -h::
        Print a short usage message and exit.
 
+-z <fuzz>::
+        Pass the timestamp fuzz factor to cvsps.
+
+-s <subst>::
+       Substitute the character "/" in branch names with <subst>
+
 OUTPUT
 ------
 If '-v' is specified, the script reports what it is doing.