Merge 'fixes' branch.
[git/jrn.git] / Documentation / git-cvsimport.txt
blobcd01994877240fdc725aab7050d0634e7a15db2e
1 git-cvsimport(1)
2 ================
3 v0.1, July 2005
5 NAME
6 ----
7 git-cvsimport - Import a CVS repository into git
10 SYNOPSIS
11 --------
12 'git-cvsimport' [ -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> ]
18 DESCRIPTION
19 -----------
20 Imports a CVS repository into git. It will either create a new
21 repository, or incrementally import into an existing one.
23 Splitting the CVS log into patch sets is done by 'cvsps'.
24 At least version 2.1 is required.
26 OPTIONS
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.
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.
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.
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. 
47 -u::
48         Convert underscores in tag and branch names to dots.
50 -o <branch-for-HEAD>::
51         The 'HEAD' branch from CVS is imported to the 'origin' branch within
52         the git repository, as 'HEAD' already has a special meaning for git.
53         Use this option if you want to import into a different branch.
55         Use '-o master' for continuing an import that was initially done by
56         the old cvs2git tool.
58 -p <options-for-cvsps>::
59         Additional options for cvsps.
60         The options '-u' and '-A' are implicit and should not be used here.
62         If you need to pass multiple options, separate them with a comma.
64 -m::    
65         Attempt to detect merges based on the commit message. This option
66         will enable default regexes that try to capture the name source 
67         branch name from the commit message. 
69 -M <regex>::
70         Attempt to detect merges based on the commit message with a custom
71         regex. It can be used with -m to also see the default regexes. 
72         You must escape forward slashes. 
74 -v::
75         Verbosity: let 'cvsimport' report what it is doing.
77 <CVS_module>::
78         The CVS module you want to import. Relative to <CVSROOT>.
80 -h::
81         Print a short usage message and exit.
83 -z <fuzz>::
84         Pass the timestamp fuzz factor to cvsps.
86 -s <subst>::
87         Substitute the character "/" in branch names with <subst>
89 OUTPUT
90 ------
91 If '-v' is specified, the script reports what it is doing.
93 Otherwise, success is indicated the Unix way, i.e. by simply exiting with
94 a zero exit status.
97 Author
98 ------
99 Written by Matthias Urlichs <smurf@smurf.noris.de>, with help from
100 various participants of the git-list <git@vger.kernel.org>.
102 Documentation
103 --------------
104 Documentation by Matthias Urlichs <smurf@smurf.noris.de>.
108 Part of the gitlink:git[7] suite