Merge http://www.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 'git-cvsimport' [ -o <branch-for-HEAD> ] [ -h ] [ -v ]
12 [ -d <CVSROOT> ] [ -p <options-for-cvsps> ]
13 [ -C <git_repository> ] [ -i ] [ -k ]
14 [ -s <subst> ] [ -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 cache 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 -m::
64 Attempt to detect merges based on the commit message. This option
65 will enable default regexes that try to capture the name source
66 branch name from the commit message.
67
68 -M <regex>::
69 Attempt to detect merges based on the commit message with a custom
70 regex. It can be used with -m to also see the default regexes.
71 You must escape forward slashes.
72
73 -v::
74 Verbosity: let 'cvsimport' report what it is doing.
75
76 <CVS_module>::
77 The CVS module you want to import. Relative to <CVSROOT>.
78
79 -h::
80 Print a short usage message and exit.
81
82 -z <fuzz>::
83 Pass the timestamp fuzz factor to cvsps.
84
85 -s <subst>::
86 Substitute the character "/" in branch names with <subst>
87
88 OUTPUT
89 ------
90 If '-v' is specified, the script reports what it is doing.
91
92 Otherwise, success is indicated the Unix way, i.e. by simply exiting with
93 a zero exit status.
94
95
96 Author
97 ------
98 Written by Matthias Urlichs <smurf@smurf.noris.de>, with help from
99 various participants of the git-list <git@vger.kernel.org>.
100
101 Documentation
102 --------------
103 Documentation by Matthias Urlichs <smurf@smurf.noris.de>.
104
105 GIT
106 ---
107 Part of the gitlink:git[7] suite
108