44713949a59283b68567369088e2b74f073e57d0
[git/git.git] / Documentation / git-cvsimport.txt
1 git-cvsimport(1)
2 ================
3
4 NAME
5 ----
6 git-cvsimport - Import a CVS repository into git
7
8
9 SYNOPSIS
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
17 DESCRIPTION
18 -----------
19 Imports a CVS repository into git. It will either create a new
20 repository, or incrementally import into an existing one.
21
22 Splitting the CVS log into patch sets is done by 'cvsps'.
23 At least version 2.1 is required.
24
25 You should *never* do any work of your own on the branches that are
26 created 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
28 to work with; after that, you need to 'git merge' incremental imports, or
29 any CVS branches, yourself.
30
31 OPTIONS
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 +
60 Use '-o master' for continuing an import that was initially done by
61 the 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 +
67 If 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, in seconds. If unset,
94 cvsps defaults to 300s.
95
96 -s <subst>::
97 Substitute the character "/" in branch names with <subst>
98
99 -A <author-conv-file>::
100 CVS by default uses the Unix username when writing its
101 commit logs. Using this option and an author-conv-file
102 in this format
103
104 -a::
105 Import all commits, including recent ones. cvsimport by default
106 skips commits that have a timestamp less than 10 minutes ago.
107
108 -S <regex>::
109 Skip paths matching the regex.
110
111 -L <limit>::
112 Limit the number of commits imported. Workaround for cases where
113 cvsimport leaks memory.
114
115 +
116 ---------
117 exon=Andreas Ericsson <ae@op5.se>
118 spawn=Simon Pawn <spawn@frog-pond.org>
119
120 ---------
121 +
122 git-cvsimport will make it appear as those authors had
123 their GIT_AUTHOR_NAME and GIT_AUTHOR_EMAIL set properly
124 all along.
125 +
126 For convenience, this data is saved to $GIT_DIR/cvs-authors
127 each time the -A option is provided and read from that same
128 file each time git-cvsimport is run.
129 +
130 It is not recommended to use this feature if you intend to
131 export changes back to CVS again later with
132 gitlink:git-cvsexportcommit[1].
133
134 OUTPUT
135 ------
136 If '-v' is specified, the script reports what it is doing.
137
138 Otherwise, success is indicated the Unix way, i.e. by simply exiting with
139 a zero exit status.
140
141
142 Author
143 ------
144 Written by Matthias Urlichs <smurf@smurf.noris.de>, with help from
145 various participants of the git-list <git@vger.kernel.org>.
146
147 Documentation
148 --------------
149 Documentation by Matthias Urlichs <smurf@smurf.noris.de>.
150
151 GIT
152 ---
153 Part of the gitlink:git[7] suite
154