Documentation / git-cvsimport-script.txton commit Documentation: multi-head fetch. (ab9b313)
   1git-cvsimport-script(1)
   2=======================
   3v0.1, July 2005
   4
   5NAME
   6----
   7git-cvsimport-script - Import a CVS repository into git
   8
   9
  10SYNOPSIS
  11--------
  12'git-cvsimport-script' [ -o <branch-for-HEAD> ] [ -h ] [ -v ]
  13                        [ -d <CVSROOT> ] [ -p <options-for-cvsps> ]
  14                        [ -C <GIT_repository> ] [ -i ] [ -k ]
  15                        [ -s <subst> ] [ -m ] [ -M regex ] [ <CVS_module> ]
  16
  17
  18DESCRIPTION
  19-----------
  20Imports a CVS repository into git. It will either create a new
  21repository, or incrementally import into an existing one.
  22
  23Splitting the CVS log into patch sets is done by 'cvsps'.
  24At least version 2.1 is required.
  25
  26OPTIONS
  27-------
  28-d <CVSROOT>::
  29        The root of the CVS archive. May be local (a simple path) or remote;
  30        currently, only the :local:, :ext: and :pserver: access methods 
  31        are supported.
  32
  33-C <target-dir>::
  34        The GIT repository to import to.  If the directory doesn't
  35        exist, it will be created.  Default is the current directory.
  36
  37-i::
  38        Import-only: don't perform a checkout after importing.  This option
  39        ensures the working directory and cache remain untouched and will
  40        not create them if they do not exist.
  41
  42-k::
  43        Kill keywords: will extract files with -kk from the CVS archive
  44        to avoid noisy changesets. Highly recommended, but off by default
  45        to preserve compatibility with early imported trees. 
  46
  47-o <branch-for-HEAD>::
  48        The 'HEAD' branch from CVS is imported to the 'origin' branch within
  49        the git repository, as 'HEAD' already has a special meaning for git.
  50        Use this option if you want to import into a different branch.
  51
  52        Use '-o master' for continuing an import that was initially done by
  53        the old cvs2git tool.
  54
  55-p <options-for-cvsps>::
  56        Additional options for cvsps.
  57        The options '-u' and '-A' are implicit and should not be used here.
  58
  59        If you need to pass multiple options, separate them with a comma.
  60
  61-m::    
  62        Attempt to detect merges based on the commit message. This option
  63        will enable default regexes that try to capture the name source 
  64        branch name from the commit message. 
  65
  66-M <regex>::
  67        Attempt to detect merges based on the commit message with a custom
  68        regex. It can be used with -m to also see the default regexes. 
  69        You must escape forward slashes. 
  70
  71-v::
  72        Verbosity: let 'cvsimport' report what it is doing.
  73
  74<CVS_module>::
  75        The CVS module you want to import. Relative to <CVSROOT>.
  76
  77-h::
  78        Print a short usage message and exit.
  79
  80-z <fuzz>::
  81        Pass the timestamp fuzz factor to cvsps.
  82
  83-s <subst>::
  84        Substitute the character "/" in branch names with <subst>
  85
  86OUTPUT
  87------
  88If '-v' is specified, the script reports what it is doing.
  89
  90Otherwise, success is indicated the Unix way, i.e. by simply exiting with
  91a zero exit status.
  92
  93
  94Author
  95------
  96Written by Matthias Urlichs <smurf@smurf.noris.de>, with help from
  97various participants of the git-list <git@vger.kernel.org>.
  98
  99Documentation
 100--------------
 101Documentation by Matthias Urlichs <smurf@smurf.noris.de>.
 102
 103GIT
 104---
 105Part of the link:git.html[git] suite
 106