Commit | Line | Data |
---|---|---|
3397f9df EW |
1 | git-svn(1) |
2 | ========== | |
3 | ||
4 | NAME | |
5 | ---- | |
ab81a364 | 6 | git-svn - Bidirectional operation between a Subversion repository and git |
3397f9df EW |
7 | |
8 | SYNOPSIS | |
9 | -------- | |
b1889c36 | 10 | 'git svn' <command> [options] [arguments] |
3397f9df EW |
11 | |
12 | DESCRIPTION | |
13 | ----------- | |
647ac702 | 14 | 'git svn' is a simple conduit for changesets between Subversion and git. |
8cb070a4 | 15 | It provides a bidirectional flow of changes between a Subversion and a git |
1168d402 | 16 | repository. |
3397f9df | 17 | |
647ac702 | 18 | 'git svn' can track a standard Subversion repository, |
ab81a364 MB |
19 | following the common "trunk/branches/tags" layout, with the --stdlayout option. |
20 | It can also follow branches and tags in any layout with the -T/-t/-b options | |
21 | (see options to 'init' below, and also the 'clone' command). | |
3397f9df | 22 | |
ab81a364 | 23 | Once tracking a Subversion repository (with any of the above methods), the git |
8cb070a4 BG |
24 | repository can be updated from Subversion by the 'fetch' command and |
25 | Subversion updated from git by the 'dcommit' command. | |
3397f9df EW |
26 | |
27 | COMMANDS | |
28 | -------- | |
0ea4d4c9 JF |
29 | |
30 | 'init':: | |
a836a0e1 | 31 | Initializes an empty git repository with additional |
647ac702 | 32 | metadata directories for 'git svn'. The Subversion URL |
a836a0e1 EW |
33 | may be specified as a command-line argument, or as full |
34 | URL arguments to -T/-t/-b. Optionally, the target | |
35 | directory to operate on can be specified as a second | |
36 | argument. Normally this command initializes the current | |
37 | directory. | |
3397f9df | 38 | |
cc1793e2 KH |
39 | -T<trunk_subdir>;; |
40 | --trunk=<trunk_subdir>;; | |
41 | -t<tags_subdir>;; | |
42 | --tags=<tags_subdir>;; | |
43 | -b<branches_subdir>;; | |
44 | --branches=<branches_subdir>;; | |
8f728fb9 | 45 | -s;; |
46 | --stdlayout;; | |
a836a0e1 EW |
47 | These are optional command-line options for init. Each of |
48 | these flags can point to a relative repository path | |
ab81a364 MB |
49 | (--tags=project/tags) or a full url |
50 | (--tags=https://foo.org/project/tags). | |
51 | You can specify more than one --tags and/or --branches options, in case | |
52 | your Subversion repository places tags or branches under multiple paths. | |
53 | The option --stdlayout is | |
8f728fb9 | 54 | a shorthand way of setting trunk,tags,branches as the relative paths, |
55 | which is the Subversion default. If any of the other options are given | |
56 | as well, they take precedence. | |
cc1793e2 | 57 | --no-metadata;; |
0dfaf0a4 | 58 | Set the 'noMetadata' option in the [svn-remote] config. |
cc1793e2 | 59 | --use-svm-props;; |
0dfaf0a4 | 60 | Set the 'useSvmProps' option in the [svn-remote] config. |
cc1793e2 | 61 | --use-svnsync-props;; |
0dfaf0a4 | 62 | Set the 'useSvnsyncProps' option in the [svn-remote] config. |
cc1793e2 | 63 | --rewrite-root=<URL>;; |
0dfaf0a4 | 64 | Set the 'rewriteRoot' option in the [svn-remote] config. |
cc1793e2 | 65 | --username=<USER>;; |
a0d7fe3f SV |
66 | For transports that SVN handles authentication for (http, |
67 | https, and plain svn), specify the username. For other | |
68 | transports (eg svn+ssh://), you must include the username in | |
69 | the URL, eg svn+ssh://foo@svn.bar.com/project | |
cc1793e2 | 70 | --prefix=<prefix>;; |
a836a0e1 EW |
71 | This allows one to specify a prefix which is prepended |
72 | to the names of remotes if trunk/branches/tags are | |
73 | specified. The prefix does not automatically include a | |
74 | trailing slash, so be sure you include one in the | |
0d351e9c GP |
75 | argument if that is what you want. If --branches/-b is |
76 | specified, the prefix must include a trailing slash. | |
77 | Setting a prefix is useful if you wish to track multiple | |
78 | projects that share a common repository. | |
88ec2054 BJ |
79 | --ignore-paths=<regex>;; |
80 | When passed to 'init' or 'clone' this regular expression will | |
81 | be preserved as a config key. See 'fetch' for a description | |
82 | of '--ignore-paths'. | |
6b48829d EW |
83 | --no-minimize-url;; |
84 | When tracking multiple directories (using --stdlayout, | |
85 | --branches, or --tags options), git svn will attempt to connect | |
86 | to the root (or highest allowed level) of the Subversion | |
87 | repository. This default allows better tracking of history if | |
88 | entire projects are moved within a repository, but may cause | |
89 | issues on repositories where read access restrictions are in | |
90 | place. Passing '--no-minimize-url' will allow git svn to | |
91 | accept URLs as-is without attempting to connect to a higher | |
92 | level directory. This option is off by default when only | |
93 | one URL/branch is tracked (it would do little good). | |
81c5a0e6 | 94 | |
a836a0e1 | 95 | 'fetch':: |
a836a0e1 EW |
96 | Fetch unfetched revisions from the Subversion remote we are |
97 | tracking. The name of the [svn-remote "..."] section in the | |
98 | .git/config file may be specified as an optional command-line | |
99 | argument. | |
b705ba43 | 100 | |
e82f0d73 PH |
101 | --localtime;; |
102 | Store Git commit times in the local timezone instead of UTC. This | |
647ac702 | 103 | makes 'git log' (even without --date=local) show the same times |
e82f0d73 PH |
104 | that `svn log` would in the local timezone. |
105 | ||
c2abd83f JM |
106 | --parent;; |
107 | Fetch only from the SVN parent of the current HEAD. | |
6c32a7a9 | 108 | + |
e82f0d73 PH |
109 | This doesn't interfere with interoperating with the Subversion |
110 | repository you cloned from, but if you wish for your local Git | |
111 | repository to be able to interoperate with someone else's local Git | |
112 | repository, either don't use this option or you should both use it in | |
113 | the same local timezone. | |
114 | ||
6076b843 | 115 | --ignore-paths=<regex>;; |
0d8bee71 | 116 | This allows one to specify a Perl regular expression that will |
6076b843 | 117 | cause skipping of all matching paths from checkout from SVN. |
0d8bee71 BJ |
118 | The '--ignore-paths' option should match for every 'fetch' |
119 | (including automatic fetches due to 'clone', 'dcommit', | |
120 | 'rebase', etc) on a given repository. | |
6c32a7a9 YD |
121 | + |
122 | [verse] | |
0d8bee71 | 123 | config key: svn-remote.<name>.ignore-paths |
6c32a7a9 YD |
124 | + |
125 | If the ignore-paths config key is set and the command line option is | |
126 | also given, both regular expressions will be used. | |
127 | + | |
0d8bee71 | 128 | Examples: |
6c32a7a9 YD |
129 | + |
130 | -- | |
131 | Skip "doc*" directory for every fetch;; | |
132 | + | |
133 | ------------------------------------------------------------------------ | |
134 | --ignore-paths="^doc" | |
135 | ------------------------------------------------------------------------ | |
0d8bee71 | 136 | |
6c32a7a9 YD |
137 | Skip "branches" and "tags" of first level directories;; |
138 | + | |
139 | ------------------------------------------------------------------------ | |
140 | --ignore-paths="^[^/]+/(?:branches|tags)" | |
141 | ------------------------------------------------------------------------ | |
142 | -- | |
6076b843 | 143 | |
eb1f7e0d YD |
144 | --use-log-author;; |
145 | When retrieving svn commits into git (as part of fetch, rebase, or | |
146 | dcommit operations), look for the first From: or Signed-off-by: line | |
147 | in the log message and use that as the author string. | |
148 | --add-author-from;; | |
149 | When committing to svn from git (as part of commit or dcommit | |
150 | operations), if the existing log message doesn't already have a | |
151 | From: or Signed-off-by: line, append a From: line based on the | |
152 | git commit's author string. If you use this, then --use-log-author | |
153 | will retrieve a valid author string for all commits. | |
154 | ||
a81ed0b6 EW |
155 | 'clone':: |
156 | Runs 'init' and 'fetch'. It will automatically create a | |
157 | directory based on the basename of the URL passed to it; | |
158 | or if a second argument is passed; it will create a directory | |
159 | and work within that. It accepts all arguments that the | |
160 | 'init' and 'fetch' commands accept; with the exception of | |
0da3e1d2 YD |
161 | '--fetch-all' and '--parent'. After a repository is cloned, |
162 | the 'fetch' command will be able to update revisions without | |
163 | affecting the working tree; and the 'rebase' command will be | |
164 | able to update the working tree with the latest changes. | |
a81ed0b6 EW |
165 | |
166 | 'rebase':: | |
167 | This fetches revisions from the SVN parent of the current HEAD | |
168 | and rebases the current (uncommitted to SVN) work against it. | |
6c32a7a9 | 169 | + |
647ac702 YD |
170 | This works similarly to `svn update` or 'git pull' except that |
171 | it preserves linear history with 'git rebase' instead of | |
172 | 'git merge' for ease of dcommitting with 'git svn'. | |
6c32a7a9 | 173 | + |
647ac702 | 174 | This accepts all options that 'git svn fetch' and 'git rebase' |
483bc4f0 | 175 | accept. However, '--fetch-all' only fetches from the current |
112f6385 | 176 | [svn-remote], and not all [svn-remote] definitions. |
6c32a7a9 | 177 | + |
647ac702 | 178 | Like 'git rebase'; this requires that the working tree be clean |
112f6385 | 179 | and have no uncommitted changes. |
cc1793e2 | 180 | |
dee41f3e EW |
181 | -l;; |
182 | --local;; | |
647ac702 | 183 | Do not fetch remotely; only run 'git rebase' against the |
dee41f3e | 184 | last fetched commit from the upstream SVN. |
a81ed0b6 | 185 | |
b22d4497 | 186 | 'dcommit':: |
2eff1425 | 187 | Commit each diff from a specified head directly to the SVN |
b22d4497 | 188 | repository, and then rebase or reset (depending on whether or |
2eff1425 EW |
189 | not there is a diff between SVN and head). This will create |
190 | a revision in SVN for each commit in git. | |
647ac702 | 191 | It is recommended that you run 'git svn' fetch and rebase (not |
2eff1425 EW |
192 | pull or merge) your commits against the latest changes in the |
193 | SVN repository. | |
5eec27e3 | 194 | An optional revision or branch argument may be specified, and |
647ac702 | 195 | causes 'git svn' to do all work on that revision/branch |
5eec27e3 | 196 | instead of HEAD. |
3289e86e | 197 | This is advantageous over 'set-tree' (below) because it produces |
b22d4497 | 198 | cleaner, more linear history. |
171af110 KH |
199 | + |
200 | --no-rebase;; | |
201 | After committing, do not rebase or reset. | |
ba24e745 EW |
202 | --commit-url <URL>;; |
203 | Commit to this SVN URL (the full path). This is intended to | |
647ac702 | 204 | allow existing 'git svn' repositories created with one transport |
ba24e745 EW |
205 | method (e.g. `svn://` or `http://` for anonymous read) to be |
206 | reused if a user is later given access to an alternate transport | |
207 | method (e.g. `svn+ssh://` or `https://`) for commit. | |
6c32a7a9 YD |
208 | + |
209 | [verse] | |
0df84059 | 210 | config key: svn-remote.<name>.commiturl |
0df84059 | 211 | config key: svn.commiturl (overwrites all svn-remote.<name>.commiturl options) |
6c32a7a9 YD |
212 | + |
213 | Using this option for any other purpose (don't ask) is very strongly | |
214 | discouraged. | |
b22d4497 | 215 | |
5de70efb FR |
216 | 'branch':: |
217 | Create a branch in the SVN repository. | |
218 | ||
219 | -m;; | |
220 | --message;; | |
221 | Allows to specify the commit message. | |
222 | ||
223 | -t;; | |
224 | --tag;; | |
225 | Create a tag by using the tags_subdir instead of the branches_subdir | |
226 | specified during git svn init. | |
227 | ||
ab81a364 MB |
228 | -d;; |
229 | --destination;; | |
230 | If more than one --branches (or --tags) option was given to the 'init' | |
231 | or 'clone' command, you must provide the location of the branch (or | |
232 | tag) you wish to create in the SVN repository. The value of this | |
233 | option must match one of the paths specified by a --branches (or | |
234 | --tags) option. You can see these paths with the commands | |
235 | + | |
236 | git config --get-all svn-remote.<name>.branches | |
237 | git config --get-all svn-remote.<name>.tags | |
238 | + | |
239 | where <name> is the name of the SVN repository as specified by the -R option to | |
240 | 'init' (or "svn" by default). | |
241 | ||
5de70efb FR |
242 | 'tag':: |
243 | Create a tag in the SVN repository. This is a shorthand for | |
244 | 'branch -t'. | |
245 | ||
e8f5d908 EW |
246 | 'log':: |
247 | This should make it easy to look up svn log messages when svn | |
248 | users refer to -r/--revision numbers. | |
112f6385 SV |
249 | + |
250 | The following features from `svn log' are supported: | |
251 | + | |
252 | -- | |
6c32a7a9 YD |
253 | -r <n>[:<n>];; |
254 | --revision=<n>[:<n>];; | |
112f6385 SV |
255 | is supported, non-numeric args are not: |
256 | HEAD, NEXT, BASE, PREV, etc ... | |
6c32a7a9 YD |
257 | -v;; |
258 | --verbose;; | |
112f6385 SV |
259 | it's not completely compatible with the --verbose |
260 | output in svn log, but reasonably close. | |
261 | --limit=<n>;; | |
262 | is NOT the same as --max-count, doesn't count | |
263 | merged/excluded commits | |
264 | --incremental;; | |
265 | supported | |
266 | -- | |
267 | + | |
268 | New features: | |
269 | + | |
270 | -- | |
271 | --show-commit;; | |
272 | shows the git commit sha1, as well | |
273 | --oneline;; | |
274 | our version of --pretty=oneline | |
275 | -- | |
276 | + | |
a50a5c8f MV |
277 | NOTE: SVN itself only stores times in UTC and nothing else. The regular svn |
278 | client converts the UTC time to the local time (or based on the TZ= | |
279 | environment). This command has the same behaviour. | |
280 | + | |
647ac702 | 281 | Any other arguments are passed directly to 'git log' |
e8f5d908 | 282 | |
6fb5375e | 283 | 'blame':: |
4be40381 SG |
284 | Show what revision and author last modified each line of a file. The |
285 | output of this mode is format-compatible with the output of | |
286 | `svn blame' by default. Like the SVN blame command, | |
287 | local uncommitted changes in the working copy are ignored; | |
288 | the version of the file in the HEAD revision is annotated. Unknown | |
647ac702 | 289 | arguments are passed directly to 'git blame'. |
6fb5375e | 290 | + |
4be40381 | 291 | --git-format;; |
647ac702 | 292 | Produce output in the same format as 'git blame', but with |
4be40381 SG |
293 | SVN revision numbers instead of git commit hashes. In this mode, |
294 | changes that haven't been committed to SVN (including local | |
295 | working-copy edits) are shown as revision 0. | |
6fb5375e | 296 | |
26e60160 AR |
297 | 'find-rev':: |
298 | When given an SVN revision number of the form 'rN', returns the | |
b3cb7e45 AR |
299 | corresponding git commit hash (this can optionally be followed by a |
300 | tree-ish to specify which branch should be searched). When given a | |
301 | tree-ish, returns the corresponding SVN revision number. | |
26e60160 | 302 | |
3289e86e | 303 | 'set-tree':: |
e8f5d908 | 304 | You should consider using 'dcommit' instead of this command. |
3397f9df EW |
305 | Commit specified commit or tree objects to SVN. This relies on |
306 | your imported fetch data being up-to-date. This makes | |
307 | absolutely no attempts to do patching when committing to SVN, it | |
308 | simply overwrites files with those specified in the tree or | |
309 | commit. All merging is assumed to have taken place | |
647ac702 | 310 | independently of 'git svn' functions. |
3397f9df | 311 | |
da060c67 | 312 | 'create-ignore':: |
da060c67 GH |
313 | Recursively finds the svn:ignore property on directories and |
314 | creates matching .gitignore files. The resulting files are staged to | |
69239728 | 315 | be committed, but are not committed. Use -r/--revision to refer to a |
1168d402 | 316 | specific revision. |
da060c67 | 317 | |
0ea4d4c9 | 318 | 'show-ignore':: |
8f22562c EW |
319 | Recursively finds and lists the svn:ignore property on |
320 | directories. The output is suitable for appending to | |
321 | the $GIT_DIR/info/exclude file. | |
322 | ||
e8f5d908 EW |
323 | 'commit-diff':: |
324 | Commits the diff of two tree-ish arguments from the | |
647ac702 | 325 | command-line. This command does not rely on being inside an `git svn |
483bc4f0 | 326 | init`-ed repository. This command takes three arguments, (a) the |
e8f5d908 EW |
327 | original tree to diff against, (b) the new tree result, (c) the |
328 | URL of the target Subversion repository. The final argument | |
647ac702 YD |
329 | (URL) may be omitted if you are working from a 'git svn'-aware |
330 | repository (that has been `init`-ed with 'git svn'). | |
45bf473a | 331 | The -r<revision> option is required for this. |
e8f5d908 | 332 | |
e6fefa92 DK |
333 | 'info':: |
334 | Shows information about a file or directory similar to what | |
335 | `svn info' provides. Does not currently support a -r/--revision | |
8b014d71 DK |
336 | argument. Use the --url option to output only the value of the |
337 | 'URL:' field. | |
e6fefa92 | 338 | |
69239728 GH |
339 | 'proplist':: |
340 | Lists the properties stored in the Subversion repository about a | |
341 | given file or directory. Use -r/--revision to refer to a specific | |
342 | Subversion revision. | |
343 | ||
344 | 'propget':: | |
345 | Gets the Subversion property given as the first argument, for a | |
346 | file. A specific revision can be specified with -r/--revision. | |
347 | ||
348 | 'show-externals':: | |
349 | Shows the Subversion externals. Use -r/--revision to specify a | |
350 | specific revision. | |
351 | ||
2da9ee08 RAZ |
352 | 'gc':: |
353 | Compress $GIT_DIR/svn/<refname>/unhandled.log files in .git/svn | |
354 | and remove $GIT_DIR/svn/<refname>index files in .git/svn. | |
355 | ||
195643f2 BJ |
356 | 'reset':: |
357 | Undoes the effects of 'fetch' back to the specified revision. | |
358 | This allows you to re-'fetch' an SVN revision. Normally the | |
359 | contents of an SVN revision should never change and 'reset' | |
360 | should not be necessary. However, if SVN permissions change, | |
361 | or if you alter your --ignore-paths option, a 'fetch' may fail | |
362 | with "not found in commit" (file not previously visible) or | |
363 | "checksum mismatch" (missed a modification). If the problem | |
364 | file cannot be ignored forever (with --ignore-paths) the only | |
365 | way to repair the repo is to use 'reset'. | |
6c32a7a9 | 366 | + |
195643f2 | 367 | Only the rev_map and refs/remotes/git-svn are changed. Follow 'reset' |
647ac702 | 368 | with a 'fetch' and then 'git reset' or 'git rebase' to move local |
195643f2 BJ |
369 | branches onto the new tree. |
370 | ||
6c32a7a9 YD |
371 | -r <n>;; |
372 | --revision=<n>;; | |
195643f2 BJ |
373 | Specify the most recent revision to keep. All later revisions |
374 | are discarded. | |
6c32a7a9 YD |
375 | -p;; |
376 | --parent;; | |
195643f2 BJ |
377 | Discard the specified revision as well, keeping the nearest |
378 | parent instead. | |
379 | Example:;; | |
380 | Assume you have local changes in "master", but you need to refetch "r2". | |
6c32a7a9 | 381 | + |
195643f2 BJ |
382 | ------------ |
383 | r1---r2---r3 remotes/git-svn | |
384 | \ | |
385 | A---B master | |
386 | ------------ | |
6c32a7a9 | 387 | + |
195643f2 BJ |
388 | Fix the ignore-paths or SVN permissions problem that caused "r2" to |
389 | be incomplete in the first place. Then: | |
6c32a7a9 | 390 | + |
195643f2 BJ |
391 | [verse] |
392 | git svn reset -r2 -p | |
393 | git svn fetch | |
6c32a7a9 | 394 | + |
195643f2 BJ |
395 | ------------ |
396 | r1---r2'--r3' remotes/git-svn | |
397 | \ | |
398 | r2---r3---A---B master | |
399 | ------------ | |
6c32a7a9 | 400 | + |
647ac702 YD |
401 | Then fixup "master" with 'git rebase'. |
402 | Do NOT use 'git merge' or your history will not be compatible with a | |
195643f2 | 403 | future 'dcommit'! |
6c32a7a9 | 404 | + |
195643f2 BJ |
405 | [verse] |
406 | git rebase --onto remotes/git-svn A^ master | |
6c32a7a9 | 407 | + |
195643f2 BJ |
408 | ------------ |
409 | r1---r2'--r3' remotes/git-svn | |
410 | \ | |
411 | A'--B' master | |
412 | ------------ | |
413 | ||
3397f9df EW |
414 | OPTIONS |
415 | ------- | |
0ea4d4c9 | 416 | |
a836a0e1 | 417 | --shared[={false|true|umask|group|all|world|everybody}]:: |
e8f5d908 EW |
418 | --template=<template_directory>:: |
419 | Only used with the 'init' command. | |
647ac702 | 420 | These are passed directly to 'git init'. |
e8f5d908 | 421 | |
3397f9df EW |
422 | -r <ARG>:: |
423 | --revision <ARG>:: | |
6c32a7a9 YD |
424 | Used with the 'fetch' command. |
425 | + | |
a836a0e1 EW |
426 | This allows revision ranges for partial/cauterized history |
427 | to be supported. $NUMBER, $NUMBER1:$NUMBER2 (numeric ranges), | |
428 | $NUMBER:HEAD, and BASE:$NUMBER are all supported. | |
6c32a7a9 | 429 | + |
a836a0e1 EW |
430 | This can allow you to make partial mirrors when running fetch; |
431 | but is generally not recommended because history will be skipped | |
432 | and lost. | |
3397f9df EW |
433 | |
434 | -:: | |
435 | --stdin:: | |
6c32a7a9 YD |
436 | Only used with the 'set-tree' command. |
437 | + | |
0ea4d4c9 JF |
438 | Read a list of commits from stdin and commit them in reverse |
439 | order. Only the leading sha1 is read from each line, so | |
647ac702 | 440 | 'git rev-list --pretty=oneline' output can be used. |
3397f9df EW |
441 | |
442 | --rmdir:: | |
6c32a7a9 YD |
443 | Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands. |
444 | + | |
0ea4d4c9 JF |
445 | Remove directories from the SVN tree if there are no files left |
446 | behind. SVN can version empty directories, and they are not | |
447 | removed by default if there are no files left in them. git | |
448 | cannot version empty directories. Enabling this flag will make | |
449 | the commit to SVN act like git. | |
6c32a7a9 YD |
450 | + |
451 | [verse] | |
e0d10e1c | 452 | config key: svn.rmdir |
20b1d700 | 453 | |
3397f9df EW |
454 | -e:: |
455 | --edit:: | |
6c32a7a9 YD |
456 | Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands. |
457 | + | |
0ea4d4c9 JF |
458 | Edit the commit message before committing to SVN. This is off by |
459 | default for objects that are commits, and forced on when committing | |
460 | tree objects. | |
6c32a7a9 YD |
461 | + |
462 | [verse] | |
e0d10e1c | 463 | config key: svn.edit |
20b1d700 | 464 | |
72942938 EW |
465 | -l<num>:: |
466 | --find-copies-harder:: | |
6c32a7a9 YD |
467 | Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands. |
468 | + | |
647ac702 | 469 | They are both passed directly to 'git diff-tree'; see |
5162e697 | 470 | linkgit:git-diff-tree[1] for more information. |
6c32a7a9 | 471 | + |
0ea4d4c9 | 472 | [verse] |
e0d10e1c TP |
473 | config key: svn.l |
474 | config key: svn.findcopiesharder | |
20b1d700 | 475 | |
81c5a0e6 EW |
476 | -A<filename>:: |
477 | --authors-file=<filename>:: | |
6c32a7a9 YD |
478 | Syntax is compatible with the file used by 'git cvsimport': |
479 | + | |
81c5a0e6 | 480 | ------------------------------------------------------------------------ |
0ea4d4c9 | 481 | loginname = Joe User <user@example.com> |
81c5a0e6 | 482 | ------------------------------------------------------------------------ |
6c32a7a9 | 483 | + |
647ac702 YD |
484 | If this option is specified and 'git svn' encounters an SVN |
485 | committer name that does not exist in the authors-file, 'git svn' | |
0ea4d4c9 | 486 | will abort operation. The user will then have to add the |
647ac702 | 487 | appropriate entry. Re-running the previous 'git svn' command |
0ea4d4c9 | 488 | after the authors-file is modified should continue operation. |
6c32a7a9 YD |
489 | + |
490 | [verse] | |
e0d10e1c | 491 | config key: svn.authorsfile |
e8f5d908 | 492 | |
36db1edd | 493 | --authors-prog=<filename>:: |
6c32a7a9 YD |
494 | If this option is specified, for each SVN committer name that |
495 | does not exist in the authors file, the given file is executed | |
496 | with the committer name as the first argument. The program is | |
497 | expected to return a single line of the form "Name <email>", | |
498 | which will be treated as if included in the authors file. | |
36db1edd | 499 | |
e8f5d908 EW |
500 | -q:: |
501 | --quiet:: | |
647ac702 | 502 | Make 'git svn' less verbose. Specify a second time to make it |
49750f30 | 503 | even less verbose. |
e8f5d908 EW |
504 | |
505 | --repack[=<n>]:: | |
112f6385 | 506 | --repack-flags=<flags>:: |
6c32a7a9 YD |
507 | These should help keep disk usage sane for large fetches with |
508 | many revisions. | |
509 | + | |
112f6385 SV |
510 | --repack takes an optional argument for the number of revisions |
511 | to fetch before repacking. This defaults to repacking every | |
512 | 1000 commits fetched if no argument is specified. | |
6c32a7a9 | 513 | + |
647ac702 | 514 | --repack-flags are passed directly to 'git repack'. |
6c32a7a9 | 515 | + |
112f6385 | 516 | [verse] |
e0d10e1c TP |
517 | config key: svn.repack |
518 | config key: svn.repackflags | |
0ea4d4c9 | 519 | |
b22d4497 EW |
520 | -m:: |
521 | --merge:: | |
522 | -s<strategy>:: | |
523 | --strategy=<strategy>:: | |
6c32a7a9 YD |
524 | These are only used with the 'dcommit' and 'rebase' commands. |
525 | + | |
647ac702 YD |
526 | Passed directly to 'git rebase' when using 'dcommit' if a |
527 | 'git reset' cannot be used (see 'dcommit'). | |
b22d4497 EW |
528 | |
529 | -n:: | |
530 | --dry-run:: | |
6c32a7a9 YD |
531 | This can be used with the 'dcommit', 'rebase', 'branch' and |
532 | 'tag' commands. | |
533 | + | |
7d45e146 | 534 | For 'dcommit', print out the series of git arguments that would show |
b22d4497 | 535 | which diffs would be committed to SVN. |
6c32a7a9 | 536 | + |
7d45e146 SF |
537 | For 'rebase', display the local branch associated with the upstream svn |
538 | repository associated with the current branch and the URL of svn | |
539 | repository that will be fetched from. | |
6c32a7a9 | 540 | + |
5de70efb FR |
541 | For 'branch' and 'tag', display the urls that will be used for copying when |
542 | creating the branch or tag. | |
543 | ||
81c5a0e6 | 544 | |
448c81b4 EW |
545 | ADVANCED OPTIONS |
546 | ---------------- | |
0ea4d4c9 | 547 | |
448c81b4 EW |
548 | -i<GIT_SVN_ID>:: |
549 | --id <GIT_SVN_ID>:: | |
6c32a7a9 YD |
550 | This sets GIT_SVN_ID (instead of using the environment). This |
551 | allows the user to override the default refname to fetch from | |
552 | when tracking a single URL. The 'log' and 'dcommit' commands | |
553 | no longer require this switch as an argument. | |
0ea4d4c9 | 554 | |
9760adcc EW |
555 | -R<remote name>:: |
556 | --svn-remote <remote name>:: | |
557 | Specify the [svn-remote "<remote name>"] section to use, | |
a836a0e1 EW |
558 | this allows SVN multiple repositories to be tracked. |
559 | Default: "svn" | |
9760adcc | 560 | |
e8f5d908 EW |
561 | --follow-parent:: |
562 | This is especially helpful when we're tracking a directory | |
563 | that has been moved around within the repository, or if we | |
564 | started tracking a branch and never tracked the trunk it was | |
0bed5eaa EW |
565 | descended from. This feature is enabled by default, use |
566 | --no-follow-parent to disable it. | |
6c32a7a9 YD |
567 | + |
568 | [verse] | |
e0d10e1c | 569 | config key: svn.followparent |
e8f5d908 | 570 | |
a81ed0b6 EW |
571 | CONFIG FILE-ONLY OPTIONS |
572 | ------------------------ | |
a81ed0b6 | 573 | |
0dfaf0a4 EW |
574 | svn.noMetadata:: |
575 | svn-remote.<name>.noMetadata:: | |
6c32a7a9 YD |
576 | This gets rid of the 'git-svn-id:' lines at the end of every commit. |
577 | + | |
647ac702 | 578 | If you lose your .git/svn/git-svn/.rev_db file, 'git svn' will not |
112f6385 SV |
579 | be able to rebuild it and you won't be able to fetch again, |
580 | either. This is fine for one-shot imports. | |
6c32a7a9 | 581 | + |
647ac702 | 582 | The 'git svn log' command will not work on repositories using |
112f6385 SV |
583 | this, either. Using this conflicts with the 'useSvmProps' |
584 | option for (hopefully) obvious reasons. | |
97ae0911 | 585 | |
0dfaf0a4 EW |
586 | svn.useSvmProps:: |
587 | svn-remote.<name>.useSvmProps:: | |
6c32a7a9 YD |
588 | This allows 'git svn' to re-map repository URLs and UUIDs from |
589 | mirrors created using SVN::Mirror (or svk) for metadata. | |
590 | + | |
112f6385 SV |
591 | If an SVN revision has a property, "svm:headrev", it is likely |
592 | that the revision was created by SVN::Mirror (also used by SVK). | |
593 | The property contains a repository UUID and a revision. We want | |
594 | to make it look like we are mirroring the original URL, so | |
595 | introduce a helper function that returns the original identity | |
596 | URL and UUID, and use it when generating metadata in commit | |
597 | messages. | |
97ae0911 | 598 | |
0dfaf0a4 EW |
599 | svn.useSvnsyncProps:: |
600 | svn-remote.<name>.useSvnsyncprops:: | |
a81ed0b6 EW |
601 | Similar to the useSvmProps option; this is for users |
602 | of the svnsync(1) command distributed with SVN 1.4.x and | |
603 | later. | |
604 | ||
0dfaf0a4 | 605 | svn-remote.<name>.rewriteRoot:: |
a81ed0b6 | 606 | This allows users to create repositories from alternate |
647ac702 | 607 | URLs. For example, an administrator could run 'git svn' on the |
a81ed0b6 EW |
608 | server locally (accessing via file://) but wish to distribute |
609 | the repository with a public http:// or svn:// URL in the | |
610 | metadata so users of it will see the public URL. | |
611 | ||
4c58a711 | 612 | svn.brokenSymlinkWorkaround:: |
6c32a7a9 YD |
613 | This disables potentially expensive checks to workaround |
614 | broken symlinks checked into SVN by broken clients. Set this | |
615 | option to "false" if you track a SVN repository with many | |
616 | empty blobs that are not symlinks. This option may be changed | |
617 | while 'git svn' is running and take effect on the next | |
618 | revision fetched. If unset, 'git svn' assumes this option to | |
619 | be "true". | |
3b2bbe9b | 620 | |
a81ed0b6 | 621 | Since the noMetadata, rewriteRoot, useSvnsyncProps and useSvmProps |
647ac702 | 622 | options all affect the metadata generated and used by 'git svn'; they |
a81ed0b6 EW |
623 | *must* be set in the configuration file before any history is imported |
624 | and these settings should never be changed once they are set. | |
625 | ||
626 | Additionally, only one of these four options can be used per-svn-remote | |
627 | section because they affect the 'git-svn-id:' metadata line. | |
e8f5d908 | 628 | |
448c81b4 | 629 | |
112f6385 SV |
630 | BASIC EXAMPLES |
631 | -------------- | |
3397f9df | 632 | |
06ada152 | 633 | Tracking and contributing to the trunk of a Subversion-managed project: |
3397f9df | 634 | |
20b1d700 | 635 | ------------------------------------------------------------------------ |
a81ed0b6 | 636 | # Clone a repo (like git clone): |
2670ddce | 637 | git svn clone http://svn.example.com/project/trunk |
a81ed0b6 EW |
638 | # Enter the newly cloned directory: |
639 | cd trunk | |
647ac702 | 640 | # You should be on master branch, double-check with 'git branch' |
a81ed0b6 EW |
641 | git branch |
642 | # Do some work and commit locally to git: | |
643 | git commit ... | |
644 | # Something is committed to SVN, rebase your local changes against the | |
645 | # latest changes in SVN: | |
b1889c36 | 646 | git svn rebase |
a81ed0b6 EW |
647 | # Now commit your changes (that were committed previously using git) to SVN, |
648 | # as well as automatically updating your working HEAD: | |
b1889c36 | 649 | git svn dcommit |
20b1d700 | 650 | # Append svn:ignore settings to the default git exclude file: |
b1889c36 | 651 | git svn show-ignore >> .git/info/exclude |
20b1d700 | 652 | ------------------------------------------------------------------------ |
3397f9df | 653 | |
0d313b2b EW |
654 | Tracking and contributing to an entire Subversion-managed project |
655 | (complete with a trunk, tags and branches): | |
0d313b2b EW |
656 | |
657 | ------------------------------------------------------------------------ | |
a81ed0b6 | 658 | # Clone a repo (like git clone): |
2670ddce | 659 | git svn clone http://svn.example.com/project -T trunk -b branches -t tags |
a81ed0b6 EW |
660 | # View all branches and tags you have cloned: |
661 | git branch -r | |
5de70efb FR |
662 | # Create a new branch in SVN |
663 | git svn branch waldo | |
a81ed0b6 EW |
664 | # Reset your master to trunk (or any other branch, replacing 'trunk' |
665 | # with the appropriate name): | |
666 | git reset --hard remotes/trunk | |
667 | # You may only dcommit to one branch/tag/trunk at a time. The usage | |
20f50f16 | 668 | # of dcommit/rebase/show-ignore should be the same as above. |
0d313b2b EW |
669 | ------------------------------------------------------------------------ |
670 | ||
647ac702 | 671 | The initial 'git svn clone' can be quite time-consuming |
7d4aef40 AR |
672 | (especially for large Subversion repositories). If multiple |
673 | people (or one person with multiple machines) want to use | |
647ac702 YD |
674 | 'git svn' to interact with the same Subversion repository, you can |
675 | do the initial 'git svn clone' to a repository on a server and | |
676 | have each person clone that repository with 'git clone': | |
7d4aef40 AR |
677 | |
678 | ------------------------------------------------------------------------ | |
679 | # Do the initial import on a server | |
2670ddce | 680 | ssh server "cd /pub && git svn clone http://svn.example.com/project |
2b0d1033 SV |
681 | # Clone locally - make sure the refs/remotes/ space matches the server |
682 | mkdir project | |
683 | cd project | |
b1889c36 | 684 | git init |
2b0d1033 | 685 | git remote add origin server:/pub/project |
762656e0 | 686 | git config --add remote.origin.fetch '+refs/remotes/*:refs/remotes/*' |
2b0d1033 | 687 | git fetch |
9e77353e JK |
688 | # Create a local branch from one of the branches just fetched |
689 | git checkout -b master FETCH_HEAD | |
647ac702 | 690 | # Initialize 'git svn' locally (be sure to use the same URL and -T/-b/-t options as were used on server) |
2670ddce | 691 | git svn init http://svn.example.com/project |
7d4aef40 | 692 | # Pull the latest changes from Subversion |
b1889c36 | 693 | git svn rebase |
7d4aef40 AR |
694 | ------------------------------------------------------------------------ |
695 | ||
2eff1425 EW |
696 | REBASE VS. PULL/MERGE |
697 | --------------------- | |
2e93115e | 698 | |
647ac702 | 699 | Originally, 'git svn' recommended that the 'remotes/git-svn' branch be |
2eff1425 | 700 | pulled or merged from. This is because the author favored |
483bc4f0 JN |
701 | `git svn set-tree B` to commit a single head rather than the |
702 | `git svn set-tree A..B` notation to commit multiple commits. | |
2eff1425 | 703 | |
483bc4f0 | 704 | If you use `git svn set-tree A..B` to commit several diffs and you do |
2eff1425 | 705 | not have the latest remotes/git-svn merged into my-branch, you should |
483bc4f0 | 706 | use `git svn rebase` to update your work branch instead of `git pull` or |
ccf497de | 707 | `git merge`. `pull`/`merge` can cause non-linear history to be flattened |
2eff1425 EW |
708 | when committing into SVN, which can lead to merge commits reversing |
709 | previous commits in SVN. | |
2e93115e | 710 | |
3397f9df EW |
711 | DESIGN PHILOSOPHY |
712 | ----------------- | |
713 | Merge tracking in Subversion is lacking and doing branched development | |
647ac702 | 714 | with Subversion can be cumbersome as a result. While 'git svn' can track |
bd43098c EW |
715 | copy history (including branches and tags) for repositories adopting a |
716 | standard layout, it cannot yet represent merge history that happened | |
717 | inside git back upstream to SVN users. Therefore it is advised that | |
718 | users keep history as linear as possible inside git to ease | |
719 | compatibility with SVN (see the CAVEATS section below). | |
1d52aba8 | 720 | |
aabb2e51 EW |
721 | CAVEATS |
722 | ------- | |
723 | ||
724 | For the sake of simplicity and interoperating with a less-capable system | |
647ac702 YD |
725 | (SVN), it is recommended that all 'git svn' users clone, fetch and dcommit |
726 | directly from the SVN server, and avoid all 'git clone'/'pull'/'merge'/'push' | |
aabb2e51 EW |
727 | operations between git repositories and branches. The recommended |
728 | method of exchanging code between git branches and users is | |
647ac702 | 729 | 'git format-patch' and 'git am', or just 'dcommit'ing to the SVN repository. |
aabb2e51 | 730 | |
647ac702 | 731 | Running 'git merge' or 'git pull' is NOT recommended on a branch you |
483bc4f0 | 732 | plan to 'dcommit' from. Subversion does not represent merges in any |
aabb2e51 EW |
733 | reasonable or useful fashion; so users using Subversion cannot see any |
734 | merges you've made. Furthermore, if you merge or pull from a git branch | |
483bc4f0 | 735 | that is a mirror of an SVN branch, 'dcommit' may commit to the wrong |
aabb2e51 EW |
736 | branch. |
737 | ||
647ac702 YD |
738 | 'git clone' does not clone branches under the refs/remotes/ hierarchy or |
739 | any 'git svn' metadata, or config. So repositories created and managed with | |
740 | using 'git svn' should use 'rsync' for cloning, if cloning is to be done | |
aabb2e51 EW |
741 | at all. |
742 | ||
647ac702 | 743 | Since 'dcommit' uses rebase internally, any git branches you 'git push' to |
483bc4f0 | 744 | before 'dcommit' on will require forcing an overwrite of the existing ref |
aabb2e51 | 745 | on the remote repository. This is generally considered bad practice, |
483bc4f0 | 746 | see the linkgit:git-push[1] documentation for details. |
aabb2e51 | 747 | |
483bc4f0 | 748 | Do not use the --amend option of linkgit:git-commit[1] on a change you've |
aabb2e51 EW |
749 | already dcommitted. It is considered bad practice to --amend commits |
750 | you've already pushed to a remote repository for other users, and | |
751 | dcommit with SVN is analogous to that. | |
752 | ||
647ac702 | 753 | When using multiple --branches or --tags, 'git svn' does not automatically |
ab81a364 MB |
754 | handle name collisions (for example, if two branches from different paths have |
755 | the same name, or if a branch and a tag have the same name). In these cases, | |
756 | use 'init' to set up your git repository then, before your first 'fetch', edit | |
757 | the .git/config file so that the branches and tags are associated with | |
758 | different name spaces. For example: | |
759 | ||
760 | branches = stable/*:refs/remotes/svn/stable/* | |
761 | branches = debug/*:refs/remotes/svn/debug/* | |
762 | ||
3397f9df EW |
763 | BUGS |
764 | ---- | |
e8f5d908 | 765 | |
a81ed0b6 EW |
766 | We ignore all SVN properties except svn:executable. Any unhandled |
767 | properties are logged to $GIT_DIR/svn/<refname>/unhandled.log | |
3397f9df | 768 | |
bbe0c9b8 EW |
769 | Renamed and copied directories are not detected by git and hence not |
770 | tracked when committing to SVN. I do not plan on adding support for | |
771 | this as it's quite difficult and time-consuming to get working for all | |
a81ed0b6 EW |
772 | the possible corner cases (git doesn't do it, either). Committing |
773 | renamed and copied files are fully supported if they're similar enough | |
774 | for git to detect them. | |
bbe0c9b8 | 775 | |
a836a0e1 EW |
776 | CONFIGURATION |
777 | ------------- | |
778 | ||
647ac702 | 779 | 'git svn' stores [svn-remote] configuration information in the |
a836a0e1 EW |
780 | repository .git/config file. It is similar the core git |
781 | [remote] sections except 'fetch' keys do not accept glob | |
782 | arguments; but they are instead handled by the 'branches' | |
783 | and 'tags' keys. Since some SVN repositories are oddly | |
784 | configured with multiple projects glob expansions such those | |
785 | listed below are allowed: | |
786 | ||
787 | ------------------------------------------------------------------------ | |
788 | [svn-remote "project-a"] | |
789 | url = http://server.org/svn | |
0e5e69a3 | 790 | fetch = trunk/project-a:refs/remotes/project-a/trunk |
a836a0e1 EW |
791 | branches = branches/*/project-a:refs/remotes/project-a/branches/* |
792 | tags = tags/*/project-a:refs/remotes/project-a/tags/* | |
a836a0e1 EW |
793 | ------------------------------------------------------------------------ |
794 | ||
4ddef0e6 | 795 | Keep in mind that the '\*' (asterisk) wildcard of the local ref |
d37a8de0 | 796 | (right of the ':') *must* be the farthest right path component; |
bad542f0 | 797 | however the remote wildcard may be anywhere as long as it's an |
02783075 | 798 | independent path component (surrounded by '/' or EOL). This |
a836a0e1 | 799 | type of configuration is not automatically created by 'init' and |
647ac702 | 800 | should be manually entered with a text-editor or using 'git config'. |
a836a0e1 | 801 | |
2e93115e EW |
802 | SEE ALSO |
803 | -------- | |
5162e697 | 804 | linkgit:git-rebase[1] |
2e93115e | 805 | |
3397f9df EW |
806 | Author |
807 | ------ | |
808 | Written by Eric Wong <normalperson@yhbt.net>. | |
809 | ||
810 | Documentation | |
811 | ------------- | |
812 | Written by Eric Wong <normalperson@yhbt.net>. |