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