cache.h: move remote/connect API out of it
[gitweb.git] / Documentation / git-cvsimport.txt
index 6695ab3b4b93aa7c5829f89ceff936de48e9bc78..d1bcda28f423566dff17a7bff85f40ae07d4ca9a 100644 (file)
@@ -18,7 +18,13 @@ SYNOPSIS
 
 DESCRIPTION
 -----------
-Imports a CVS repository into git. It will either create a new
+*WARNING:* `git cvsimport` uses cvsps version 2, which is considered
+deprecated; it does not work with cvsps version 3 and later.  If you are
+performing a one-shot import of a CVS repository consider using
+link:http://cvs2svn.tigris.org/cvs2git.html[cvs2git] or
+link:https://github.com/BartMassey/parsecvs[parsecvs].
+
+Imports a CVS repository into Git. It will either create a new
 repository, or incrementally import into an existing one.
 
 Splitting the CVS log into patch sets is done by 'cvsps'.
@@ -59,18 +65,18 @@ OPTIONS
        `CVS/Repository`.
 
 -C <target-dir>::
-        The git repository to import to.  If the directory doesn't
+       The Git repository to import to.  If the directory doesn't
         exist, it will be created.  Default is the current directory.
 
 -r <remote>::
-       The git remote to import this CVS repository into.
+       The Git remote to import this CVS repository into.
        Moves all CVS branches into remotes/<remote>/<branch>
        akin to the way 'git clone' uses 'origin' by default.
 
 -o <branch-for-HEAD>::
        When no remote is specified (via -r) the 'HEAD' branch
-       from CVS is imported to the 'origin' branch within the git
-       repository, as 'HEAD' already has a special meaning for git.
+       from CVS is imported to the 'origin' branch within the Git
+       repository, as 'HEAD' already has a special meaning for Git.
        When a remote is specified the 'HEAD' branch is named
        remotes/<remote>/master mirroring 'git clone' behaviour.
        Use this option if you want to import into a different
@@ -137,17 +143,19 @@ This option can be used several times to provide several detection regexes.
 -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
+       maps the name recorded in CVS to author name, e-mail and
+       optional timezone:
 +
 ---------
        exon=Andreas Ericsson <ae@op5.se>
-       spawn=Simon Pawn <spawn@frog-pond.org>
+       spawn=Simon Pawn <spawn@frog-pond.org> America/Chicago
 
 ---------
 +
 'git cvsimport' will make it appear as those authors had
 their GIT_AUTHOR_NAME and GIT_AUTHOR_EMAIL set properly
-all along.
+all along.  If a timezone is specified, GIT_AUTHOR_DATE will
+have the corresponding offset applied.
 +
 For convenience, this data is saved to `$GIT_DIR/cvs-authors`
 each time the '-A' option is provided and read from that same
@@ -211,11 +219,9 @@ Problems related to tags:
 * Multiple tags on the same revision are not imported.
 
 If you suspect that any of these issues may apply to the repository you
-want to import consider using these alternative tools which proved to be
-more stable in practice:
+want to imort, consider using cvs2git:
 
-* cvs2git (part of cvs2svn), `http://cvs2svn.tigris.org`
-* parsecvs, `http://cgit.freedesktop.org/~keithp/parsecvs`
+* cvs2git (part of cvs2svn), `http://subversion.apache.org/`
 
 GIT
 ---