8374d90471fcf56aefeb361b41d486a4dffff998
   1git-cvsimport(1)
   2================
   3
   4NAME
   5----
   6git-cvsimport - Salvage your data out of another SCM people love to hate
   7
   8
   9SYNOPSIS
  10--------
  11[verse]
  12'git-cvsimport' [-o <branch-for-HEAD>] [-h] [-v] [-d <CVSROOT>]
  13              [-A <author-conv-file>] [-p <options-for-cvsps>] [-P <file>]
  14              [-C <git_repository>] [-z <fuzz>] [-i] [-k] [-u] [-s <subst>]
  15              [-a] [-m] [-M <regex>] [-S <regex>] [-L <commitlimit>]
  16              [<CVS_module>]
  17
  18
  19DESCRIPTION
  20-----------
  21Imports a CVS repository into git. It will either create a new
  22repository, or incrementally import into an existing one.
  23
  24Splitting the CVS log into patch sets is done by 'cvsps'.
  25At least version 2.1 is required.
  26
  27You should *never* do any work of your own on the branches that are
  28created by git-cvsimport. The initial import will create and populate a
  29"master" branch from the CVS repository's main branch which you're free
  30to work with; after that, you need to 'git merge' incremental imports, or
  31any CVS branches, yourself.
  32
  33OPTIONS
  34-------
  35-d <CVSROOT>::
  36        The root of the CVS archive. May be local (a simple path) or remote;
  37        currently, only the :local:, :ext: and :pserver: access methods 
  38        are supported.
  39
  40-C <target-dir>::
  41        The git repository to import to.  If the directory doesn't
  42        exist, it will be created.  Default is the current directory.
  43
  44-i::
  45        Import-only: don't perform a checkout after importing.  This option
  46        ensures the working directory and index remain untouched and will
  47        not create them if they do not exist.
  48
  49-k::
  50        Kill keywords: will extract files with -kk from the CVS archive
  51        to avoid noisy changesets. Highly recommended, but off by default
  52        to preserve compatibility with early imported trees. 
  53
  54-u::
  55        Convert underscores in tag and branch names to dots.
  56
  57-o <branch-for-HEAD>::
  58        The 'HEAD' branch from CVS is imported to the 'origin' branch within
  59        the git repository, as 'HEAD' already has a special meaning for git.
  60        Use this option if you want to import into a different branch.
  61+
  62Use '-o master' for continuing an import that was initially done by
  63the old cvs2git tool.
  64
  65-p <options-for-cvsps>::
  66        Additional options for cvsps.
  67        The options '-u' and '-A' are implicit and should not be used here.
  68+
  69If you need to pass multiple options, separate them with a comma.
  70
  71-P <cvsps-output-file>::
  72        Instead of calling cvsps, read the provided cvsps output file. Useful
  73        for debugging or when cvsps is being handled outside cvsimport.
  74
  75-m::    
  76        Attempt to detect merges based on the commit message. This option
  77        will enable default regexes that try to capture the name source 
  78        branch name from the commit message. 
  79
  80-M <regex>::
  81        Attempt to detect merges based on the commit message with a custom
  82        regex. It can be used with -m to also see the default regexes. 
  83        You must escape forward slashes. 
  84
  85-v::
  86        Verbosity: let 'cvsimport' report what it is doing.
  87
  88<CVS_module>::
  89        The CVS module you want to import. Relative to <CVSROOT>.
  90
  91-h::
  92        Print a short usage message and exit.
  93
  94-z <fuzz>::
  95        Pass the timestamp fuzz factor to cvsps, in seconds. If unset,
  96        cvsps defaults to 300s.
  97
  98-s <subst>::
  99        Substitute the character "/" in branch names with <subst>
 100
 101-a::
 102        Import all commits, including recent ones. cvsimport by default
 103        skips commits that have a timestamp less than 10 minutes ago.
 104
 105-S <regex>::
 106        Skip paths matching the regex.
 107
 108-L <limit>::
 109        Limit the number of commits imported. Workaround for cases where
 110        cvsimport leaks memory.
 111
 112-A <author-conv-file>::
 113        CVS by default uses the Unix username when writing its
 114        commit logs. Using this option and an author-conv-file
 115        in this format
 116+
 117---------
 118        exon=Andreas Ericsson <ae@op5.se>
 119        spawn=Simon Pawn <spawn@frog-pond.org>
 120
 121---------
 122+
 123git-cvsimport will make it appear as those authors had
 124their GIT_AUTHOR_NAME and GIT_AUTHOR_EMAIL set properly
 125all along.
 126+
 127For convenience, this data is saved to $GIT_DIR/cvs-authors
 128each time the -A option is provided and read from that same
 129file each time git-cvsimport is run.
 130+
 131It is not recommended to use this feature if you intend to
 132export changes back to CVS again later with
 133gitlink:git-cvsexportcommit[1].
 134
 135OUTPUT
 136------
 137If '-v' is specified, the script reports what it is doing.
 138
 139Otherwise, success is indicated the Unix way, i.e. by simply exiting with
 140a zero exit status.
 141
 142
 143Author
 144------
 145Written by Matthias Urlichs <smurf@smurf.noris.de>, with help from
 146various participants of the git-list <git@vger.kernel.org>.
 147
 148Documentation
 149--------------
 150Documentation by Matthias Urlichs <smurf@smurf.noris.de>.
 151
 152GIT
 153---
 154Part of the gitlink:git[7] suite
 155