[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 c257d87..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> ]
-                       <CVS_module> [ <GIT_repository> ]
+                       [ -C <GIT_repository> ] [ -i ] [ -k ]
+                       [ -s <subst> ] [ -m ] [ -M regex ] [ <CVS_module> ]
 
 
 DESCRIPTION
@@ -19,14 +20,29 @@ DESCRIPTION
 Imports a CVS repository into git. It will either create a new
 repository, or incrementally import into an existing one.
 
-Spitting the CVS log into patch sets is done by 'cvsps'.
+Splitting the CVS log into patch sets is done by 'cvsps'.
 At least version 2.1 is required.
 
 OPTIONS
 -------
 -d <CVSROOT>::
        The root of the CVS archive. May be local (a simple path) or remote;
-       currently, only the :pserver: access method is supported.
+       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
@@ -38,27 +54,35 @@ 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.
 
 <CVS_module>::
        The CVS module you want to import. Relative to <CVSROOT>.
 
-<type>::
-       Typically this matches the real type of <object> but asking
-       for a type that can trivially dereferenced from the given
-       <object> is also permitted.  An example is to ask for a
-       "tree" with <object> being a commit object that contains it,
-       or to ask for a "blob" with <object> being a tag object that
-       points at it.
-
 -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.