Merge http://www.kernel.org/pub/scm/gitk/gitk
[git/git.git] / Documentation / git-svnimport.txt
1 git-svnimport(1)
2 ================
3 v0.1, July 2005
4
5 NAME
6 ----
7 git-svnimport - Import a SVN repository into git
8
9
10 SYNOPSIS
11 --------
12 'git-svnimport' [ -o <branch-for-HEAD> ] [ -h ] [ -v ] [ -d | -D ]
13 [ -C <GIT_repository> ] [ -i ] [ -u ] [-l limit_nr_changes]
14 [ -b branch_subdir ] [ -t trunk_subdir ] [ -T tag_subdir ]
15 [ -s start_chg ] [ -m ] [ -M regex ]
16 <SVN_repository_URL> [ <path> ]
17
18
19 DESCRIPTION
20 -----------
21 Imports a SVN repository into git. It will either create a new
22 repository, or incrementally import into an existing one.
23
24 SVN access is done by the SVN:: Perl module.
25
26 git-svnimport assumes that SVN repositories are organized into one
27 "trunk" directory where the main development happens, "branch/FOO"
28 directories for branches, and "/tags/FOO" directories for tags.
29 Other subdirectories are ignored.
30
31 git-svnimport creates a file ".git/svn2git", which is required for
32 incremental SVN imports.
33
34 OPTIONS
35 -------
36 -C <target-dir>::
37 The GIT repository to import to. If the directory doesn't
38 exist, it will be created. Default is the current directory.
39
40 -s <start_rev>::
41 Start importing at this SVN change number. The default is 1.
42 +
43 When importing incementally, you might need to edit the .git/svn2git file.
44
45 -i::
46 Import-only: don't perform a checkout after importing. This option
47 ensures the working directory and cache remain untouched and will
48 not create them if they do not exist.
49
50 -t <trunk_subdir>::
51 Name the SVN trunk. Default "trunk".
52
53 -T <tag_subdir>::
54 Name the SVN subdirectory for tags. Default "tags".
55
56 -b <branch_subdir>::
57 Name the SVN subdirectory for branches. Default "branches".
58
59 -o <branch-for-HEAD>::
60 The 'trunk' branch from SVN is imported to the 'origin' branch within
61 the git repository. Use this option if you want to import into a
62 different branch.
63
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.
68
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.
73
74 -l <max_num_changes>::
75 Limit the number of SVN changesets we pull before quitting.
76 This option is necessary because the SVN library has serious memory
77 leaks; the recommended value for nontrivial imports is 100.
78
79 git-svnimport will still exit with a zero exit code. You can check
80 the size of the file ".git/svn2git" to determine whether to call
81 the importer again.
82
83 -v::
84 Verbosity: let 'svnimport' report what it is doing.
85
86 -d::
87 Use direct HTTP requests if possible. The "<path>" argument is used
88 only for retrieving the SVN logs; the path to the contents is
89 included in the SVN log.
90
91 -D::
92 Use direct HTTP requests if possible. The "<path>" argument is used
93 for retrieving the logs, as well as for the contents.
94 +
95 There's no safe way to automatically find out which of these options to
96 use, so you need to try both. Usually, the one that's wrong will die
97 with a 40x error pretty quickly.
98
99 <SVN_repository_URL>::
100 The URL of the SVN module you want to import. For local
101 repositories, use "file:///absolute/path".
102 +
103 If you're using the "-d" or "-D" option, this is the URL of the SVN
104 repository itself; it usually ends in "/svn".
105
106 <SVN_repository_URL>::
107 The URL of the SVN module you want to import. For local
108 repositories, use "file:///absolute/path".
109
110 <path>
111 The path to the module you want to check out.
112
113 -h::
114 Print a short usage message and exit.
115
116 OUTPUT
117 ------
118 If '-v' is specified, the script reports what it is doing.
119
120 Otherwise, success is indicated the Unix way, i.e. by simply exiting with
121 a zero exit status.
122
123 Author
124 ------
125 Written by Matthias Urlichs <smurf@smurf.noris.de>, with help from
126 various participants of the git-list <git@vger.kernel.org>.
127
128 Based on a cvs2git script by the same author.
129
130 Documentation
131 --------------
132 Documentation by Matthias Urlichs <smurf@smurf.noris.de>.
133
134 GIT
135 ---
136 Part of the gitlink:git[7] suite
137