update-index: do not die too early in a read-only repository.
[gitweb.git] / Documentation / git-cvsimport.txt
index dfe86ceea3ac54306e3be23f7f7b53b1ca8a3a37..f5450de74a220c2c3c842835749c20f34cfef1f2 100644 (file)
@@ -3,7 +3,7 @@ git-cvsimport(1)
 
 NAME
 ----
-git-cvsimport - Import a CVS repository into git
+git-cvsimport - Salvage your data out of another SCM people love to hate
 
 
 SYNOPSIS
@@ -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>::
@@ -84,30 +90,46 @@ If you need to pass multiple options, separate them with a comma.
        Print a short usage message and exit.
 
 -z <fuzz>::
-        Pass the timestamp fuzz factor to cvsps.
+       Pass the timestamp fuzz factor to cvsps, in seconds. If unset,
+       cvsps defaults to 300s.
 
 -s <subst>::
        Substitute the character "/" in branch names with <subst>
 
 -A <author-conv-file>::
-       CVS by default uses the unix username when writing its
+       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>
+-a::
+       Import all commits, including recent ones. cvsimport by default
+       skips commits that have a timestamp less than 10 minutes ago.
 
-       git-cvsimport will make it appear as those authors had
-       their GIT_AUTHOR_NAME and GIT_AUTHOR_EMAIL set properly
-       all along.
+-S <regex>::
+       Skip paths matching the regex.
 
-       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.
+-L <limit>::
+       Limit the number of commits imported. Workaround for cases where
+       cvsimport leaks memory.
+
++
+---------
+       exon=Andreas Ericsson <ae@op5.se>
+       spawn=Simon Pawn <spawn@frog-pond.org>
 
-       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.
+---------
++
+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
+gitlink:git-cvsexportcommit[1].
 
 OUTPUT
 ------