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