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