Merge branch 'jc/maint-fnmatch-old-style-definition' into maint
[git/git.git] / Documentation / git-svn.txt
1 git-svn(1)
2 ==========
3
4 NAME
5 ----
6 git-svn - Bidirectional operation between a Subversion repository and git
7
8 SYNOPSIS
9 --------
10 [verse]
11 'git svn' <command> [options] [arguments]
12
13 DESCRIPTION
14 -----------
15 'git svn' is a simple conduit for changesets between Subversion and git.
16 It provides a bidirectional flow of changes between a Subversion and a git
17 repository.
18
19 'git svn' can track a standard Subversion repository,
20 following the common "trunk/branches/tags" layout, with the --stdlayout option.
21 It can also follow branches and tags in any layout with the -T/-t/-b options
22 (see options to 'init' below, and also the 'clone' command).
23
24 Once tracking a Subversion repository (with any of the above methods), the git
25 repository can be updated from Subversion by the 'fetch' command and
26 Subversion updated from git by the 'dcommit' command.
27
28 COMMANDS
29 --------
30
31 'init'::
32 Initializes an empty git repository with additional
33 metadata directories for 'git svn'. The Subversion URL
34 may be specified as a command-line argument, or as full
35 URL arguments to -T/-t/-b. Optionally, the target
36 directory to operate on can be specified as a second
37 argument. Normally this command initializes the current
38 directory.
39
40 -T<trunk_subdir>;;
41 --trunk=<trunk_subdir>;;
42 -t<tags_subdir>;;
43 --tags=<tags_subdir>;;
44 -b<branches_subdir>;;
45 --branches=<branches_subdir>;;
46 -s;;
47 --stdlayout;;
48 These are optional command-line options for init. Each of
49 these flags can point to a relative repository path
50 (--tags=project/tags) or a full url
51 (--tags=https://foo.org/project/tags).
52 You can specify more than one --tags and/or --branches options, in case
53 your Subversion repository places tags or branches under multiple paths.
54 The option --stdlayout is
55 a shorthand way of setting trunk,tags,branches as the relative paths,
56 which is the Subversion default. If any of the other options are given
57 as well, they take precedence.
58 --no-metadata;;
59 Set the 'noMetadata' option in the [svn-remote] config.
60 This option is not recommended, please read the 'svn.noMetadata'
61 section of this manpage before using this option.
62 --use-svm-props;;
63 Set the 'useSvmProps' option in the [svn-remote] config.
64 --use-svnsync-props;;
65 Set the 'useSvnsyncProps' option in the [svn-remote] config.
66 --rewrite-root=<URL>;;
67 Set the 'rewriteRoot' option in the [svn-remote] config.
68 --rewrite-uuid=<UUID>;;
69 Set the 'rewriteUUID' option in the [svn-remote] config.
70 --username=<user>;;
71 For transports that SVN handles authentication for (http,
72 https, and plain svn), specify the username. For other
73 transports (eg svn+ssh://), you must include the username in
74 the URL, eg svn+ssh://foo@svn.bar.com/project
75 --prefix=<prefix>;;
76 This allows one to specify a prefix which is prepended
77 to the names of remotes if trunk/branches/tags are
78 specified. The prefix does not automatically include a
79 trailing slash, so be sure you include one in the
80 argument if that is what you want. If --branches/-b is
81 specified, the prefix must include a trailing slash.
82 Setting a prefix is useful if you wish to track multiple
83 projects that share a common repository.
84 --ignore-paths=<regex>;;
85 When passed to 'init' or 'clone' this regular expression will
86 be preserved as a config key. See 'fetch' for a description
87 of '--ignore-paths'.
88 --no-minimize-url;;
89 When tracking multiple directories (using --stdlayout,
90 --branches, or --tags options), git svn will attempt to connect
91 to the root (or highest allowed level) of the Subversion
92 repository. This default allows better tracking of history if
93 entire projects are moved within a repository, but may cause
94 issues on repositories where read access restrictions are in
95 place. Passing '--no-minimize-url' will allow git svn to
96 accept URLs as-is without attempting to connect to a higher
97 level directory. This option is off by default when only
98 one URL/branch is tracked (it would do little good).
99
100 'fetch'::
101 Fetch unfetched revisions from the Subversion remote we are
102 tracking. The name of the [svn-remote "..."] section in the
103 .git/config file may be specified as an optional command-line
104 argument.
105
106 --localtime;;
107 Store Git commit times in the local timezone instead of UTC. This
108 makes 'git log' (even without --date=local) show the same times
109 that `svn log` would in the local timezone.
110 +
111 This doesn't interfere with interoperating with the Subversion
112 repository you cloned from, but if you wish for your local Git
113 repository to be able to interoperate with someone else's local Git
114 repository, either don't use this option or you should both use it in
115 the same local timezone.
116
117 --parent;;
118 Fetch only from the SVN parent of the current HEAD.
119
120 --ignore-paths=<regex>;;
121 This allows one to specify a Perl regular expression that will
122 cause skipping of all matching paths from checkout from SVN.
123 The '--ignore-paths' option should match for every 'fetch'
124 (including automatic fetches due to 'clone', 'dcommit',
125 'rebase', etc) on a given repository.
126 +
127 [verse]
128 config key: svn-remote.<name>.ignore-paths
129 +
130 If the ignore-paths config key is set and the command line option is
131 also given, both regular expressions will be used.
132 +
133 Examples:
134 +
135 --
136 Skip "doc*" directory for every fetch;;
137 +
138 ------------------------------------------------------------------------
139 --ignore-paths="^doc"
140 ------------------------------------------------------------------------
141
142 Skip "branches" and "tags" of first level directories;;
143 +
144 ------------------------------------------------------------------------
145 --ignore-paths="^[^/]+/(?:branches|tags)"
146 ------------------------------------------------------------------------
147 --
148
149 --log-window-size=<n>;;
150 Fetch <n> log entries per request when scanning Subversion history.
151 The default is 100. For very large Subversion repositories, larger
152 values may be needed for 'clone'/'fetch' to complete in reasonable
153 time. But overly large values may lead to higher memory usage and
154 request timeouts.
155
156 'clone'::
157 Runs 'init' and 'fetch'. It will automatically create a
158 directory based on the basename of the URL passed to it;
159 or if a second argument is passed; it will create a directory
160 and work within that. It accepts all arguments that the
161 'init' and 'fetch' commands accept; with the exception of
162 '--fetch-all' and '--parent'. After a repository is cloned,
163 the 'fetch' command will be able to update revisions without
164 affecting the working tree; and the 'rebase' command will be
165 able to update the working tree with the latest changes.
166
167 --preserve-empty-dirs;;
168 Create a placeholder file in the local Git repository for each
169 empty directory fetched from Subversion. This includes directories
170 that become empty by removing all entries in the Subversion
171 repository (but not the directory itself). The placeholder files
172 are also tracked and removed when no longer necessary.
173
174 --placeholder-filename=<filename>;;
175 Set the name of placeholder files created by --preserve-empty-dirs.
176 Default: ".gitignore"
177
178 'rebase'::
179 This fetches revisions from the SVN parent of the current HEAD
180 and rebases the current (uncommitted to SVN) work against it.
181 +
182 This works similarly to `svn update` or 'git pull' except that
183 it preserves linear history with 'git rebase' instead of
184 'git merge' for ease of dcommitting with 'git svn'.
185 +
186 This accepts all options that 'git svn fetch' and 'git rebase'
187 accept. However, '--fetch-all' only fetches from the current
188 [svn-remote], and not all [svn-remote] definitions.
189 +
190 Like 'git rebase'; this requires that the working tree be clean
191 and have no uncommitted changes.
192
193 -l;;
194 --local;;
195 Do not fetch remotely; only run 'git rebase' against the
196 last fetched commit from the upstream SVN.
197
198 'dcommit'::
199 Commit each diff from the current branch directly to the SVN
200 repository, and then rebase or reset (depending on whether or
201 not there is a diff between SVN and head). This will create
202 a revision in SVN for each commit in git.
203 +
204 When an optional git branch name (or a git commit object name)
205 is specified as an argument, the subcommand works on the specified
206 branch, not on the current branch.
207 +
208 Use of 'dcommit' is preferred to 'set-tree' (below).
209 +
210 --no-rebase;;
211 After committing, do not rebase or reset.
212 --commit-url <URL>;;
213 Commit to this SVN URL (the full path). This is intended to
214 allow existing 'git svn' repositories created with one transport
215 method (e.g. `svn://` or `http://` for anonymous read) to be
216 reused if a user is later given access to an alternate transport
217 method (e.g. `svn+ssh://` or `https://`) for commit.
218 +
219 [verse]
220 config key: svn-remote.<name>.commiturl
221 config key: svn.commiturl (overwrites all svn-remote.<name>.commiturl options)
222 +
223 Using this option for any other purpose (don't ask) is very strongly
224 discouraged.
225
226 --mergeinfo=<mergeinfo>;;
227 Add the given merge information during the dcommit
228 (e.g. `--mergeinfo="/branches/foo:1-10"`). All svn server versions can
229 store this information (as a property), and svn clients starting from
230 version 1.5 can make use of it. To specify merge information from multiple
231 branches, use a single space character between the branches
232 (`--mergeinfo="/branches/foo:1-10 /branches/bar:3,5-6,8"`)
233 +
234 [verse]
235 config key: svn.pushmergeinfo
236 +
237 This option will cause git-svn to attempt to automatically populate the
238 svn:mergeinfo property in the SVN repository when possible. Currently, this can
239 only be done when dcommitting non-fast-forward merges where all parents but the
240 first have already been pushed into SVN.
241
242 --interactive;;
243 Ask the user to confirm that a patch set should actually be sent to SVN.
244 For each patch, one may answer "yes" (accept this patch), "no" (discard this
245 patch), "all" (accept all patches), or "quit".
246 +
247 'git svn dcommit' returns immediately if answer if "no" or "quit", without
248 commiting anything to SVN.
249
250 'branch'::
251 Create a branch in the SVN repository.
252
253 -m;;
254 --message;;
255 Allows to specify the commit message.
256
257 -t;;
258 --tag;;
259 Create a tag by using the tags_subdir instead of the branches_subdir
260 specified during git svn init.
261
262 -d;;
263 --destination;;
264 If more than one --branches (or --tags) option was given to the 'init'
265 or 'clone' command, you must provide the location of the branch (or
266 tag) you wish to create in the SVN repository. The value of this
267 option must match one of the paths specified by a --branches (or
268 --tags) option. You can see these paths with the commands
269 +
270 git config --get-all svn-remote.<name>.branches
271 git config --get-all svn-remote.<name>.tags
272 +
273 where <name> is the name of the SVN repository as specified by the -R option to
274 'init' (or "svn" by default).
275
276 --username;;
277 Specify the SVN username to perform the commit as. This option overrides
278 the 'username' configuration property.
279
280 --commit-url;;
281 Use the specified URL to connect to the destination Subversion
282 repository. This is useful in cases where the source SVN
283 repository is read-only. This option overrides configuration
284 property 'commiturl'.
285 +
286 git config --get-all svn-remote.<name>.commiturl
287 +
288
289 'tag'::
290 Create a tag in the SVN repository. This is a shorthand for
291 'branch -t'.
292
293 'log'::
294 This should make it easy to look up svn log messages when svn
295 users refer to -r/--revision numbers.
296 +
297 The following features from `svn log' are supported:
298 +
299 --
300 -r <n>[:<n>];;
301 --revision=<n>[:<n>];;
302 is supported, non-numeric args are not:
303 HEAD, NEXT, BASE, PREV, etc ...
304 -v;;
305 --verbose;;
306 it's not completely compatible with the --verbose
307 output in svn log, but reasonably close.
308 --limit=<n>;;
309 is NOT the same as --max-count, doesn't count
310 merged/excluded commits
311 --incremental;;
312 supported
313 --
314 +
315 New features:
316 +
317 --
318 --show-commit;;
319 shows the git commit sha1, as well
320 --oneline;;
321 our version of --pretty=oneline
322 --
323 +
324 NOTE: SVN itself only stores times in UTC and nothing else. The regular svn
325 client converts the UTC time to the local time (or based on the TZ=
326 environment). This command has the same behaviour.
327 +
328 Any other arguments are passed directly to 'git log'
329
330 'blame'::
331 Show what revision and author last modified each line of a file. The
332 output of this mode is format-compatible with the output of
333 `svn blame' by default. Like the SVN blame command,
334 local uncommitted changes in the working tree are ignored;
335 the version of the file in the HEAD revision is annotated. Unknown
336 arguments are passed directly to 'git blame'.
337 +
338 --git-format;;
339 Produce output in the same format as 'git blame', but with
340 SVN revision numbers instead of git commit hashes. In this mode,
341 changes that haven't been committed to SVN (including local
342 working-copy edits) are shown as revision 0.
343
344 'find-rev'::
345 When given an SVN revision number of the form 'rN', returns the
346 corresponding git commit hash (this can optionally be followed by a
347 tree-ish to specify which branch should be searched). When given a
348 tree-ish, returns the corresponding SVN revision number.
349
350 'set-tree'::
351 You should consider using 'dcommit' instead of this command.
352 Commit specified commit or tree objects to SVN. This relies on
353 your imported fetch data being up-to-date. This makes
354 absolutely no attempts to do patching when committing to SVN, it
355 simply overwrites files with those specified in the tree or
356 commit. All merging is assumed to have taken place
357 independently of 'git svn' functions.
358
359 'create-ignore'::
360 Recursively finds the svn:ignore property on directories and
361 creates matching .gitignore files. The resulting files are staged to
362 be committed, but are not committed. Use -r/--revision to refer to a
363 specific revision.
364
365 'show-ignore'::
366 Recursively finds and lists the svn:ignore property on
367 directories. The output is suitable for appending to
368 the $GIT_DIR/info/exclude file.
369
370 'mkdirs'::
371 Attempts to recreate empty directories that core git cannot track
372 based on information in $GIT_DIR/svn/<refname>/unhandled.log files.
373 Empty directories are automatically recreated when using
374 "git svn clone" and "git svn rebase", so "mkdirs" is intended
375 for use after commands like "git checkout" or "git reset".
376 (See the svn-remote.<name>.automkdirs config file option for
377 more information.)
378
379 'commit-diff'::
380 Commits the diff of two tree-ish arguments from the
381 command-line. This command does not rely on being inside an `git svn
382 init`-ed repository. This command takes three arguments, (a) the
383 original tree to diff against, (b) the new tree result, (c) the
384 URL of the target Subversion repository. The final argument
385 (URL) may be omitted if you are working from a 'git svn'-aware
386 repository (that has been `init`-ed with 'git svn').
387 The -r<revision> option is required for this.
388
389 'info'::
390 Shows information about a file or directory similar to what
391 `svn info' provides. Does not currently support a -r/--revision
392 argument. Use the --url option to output only the value of the
393 'URL:' field.
394
395 'proplist'::
396 Lists the properties stored in the Subversion repository about a
397 given file or directory. Use -r/--revision to refer to a specific
398 Subversion revision.
399
400 'propget'::
401 Gets the Subversion property given as the first argument, for a
402 file. A specific revision can be specified with -r/--revision.
403
404 'show-externals'::
405 Shows the Subversion externals. Use -r/--revision to specify a
406 specific revision.
407
408 'gc'::
409 Compress $GIT_DIR/svn/<refname>/unhandled.log files in .git/svn
410 and remove $GIT_DIR/svn/<refname>index files in .git/svn.
411
412 'reset'::
413 Undoes the effects of 'fetch' back to the specified revision.
414 This allows you to re-'fetch' an SVN revision. Normally the
415 contents of an SVN revision should never change and 'reset'
416 should not be necessary. However, if SVN permissions change,
417 or if you alter your --ignore-paths option, a 'fetch' may fail
418 with "not found in commit" (file not previously visible) or
419 "checksum mismatch" (missed a modification). If the problem
420 file cannot be ignored forever (with --ignore-paths) the only
421 way to repair the repo is to use 'reset'.
422 +
423 Only the rev_map and refs/remotes/git-svn are changed. Follow 'reset'
424 with a 'fetch' and then 'git reset' or 'git rebase' to move local
425 branches onto the new tree.
426
427 -r <n>;;
428 --revision=<n>;;
429 Specify the most recent revision to keep. All later revisions
430 are discarded.
431 -p;;
432 --parent;;
433 Discard the specified revision as well, keeping the nearest
434 parent instead.
435 Example:;;
436 Assume you have local changes in "master", but you need to refetch "r2".
437 +
438 ------------
439 r1---r2---r3 remotes/git-svn
440 \
441 A---B master
442 ------------
443 +
444 Fix the ignore-paths or SVN permissions problem that caused "r2" to
445 be incomplete in the first place. Then:
446 +
447 [verse]
448 git svn reset -r2 -p
449 git svn fetch
450 +
451 ------------
452 r1---r2'--r3' remotes/git-svn
453 \
454 r2---r3---A---B master
455 ------------
456 +
457 Then fixup "master" with 'git rebase'.
458 Do NOT use 'git merge' or your history will not be compatible with a
459 future 'dcommit'!
460 +
461 [verse]
462 git rebase --onto remotes/git-svn A^ master
463 +
464 ------------
465 r1---r2'--r3' remotes/git-svn
466 \
467 A'--B' master
468 ------------
469
470 OPTIONS
471 -------
472
473 --shared[=(false|true|umask|group|all|world|everybody)]::
474 --template=<template_directory>::
475 Only used with the 'init' command.
476 These are passed directly to 'git init'.
477
478 -r <arg>::
479 --revision <arg>::
480 Used with the 'fetch' command.
481 +
482 This allows revision ranges for partial/cauterized history
483 to be supported. $NUMBER, $NUMBER1:$NUMBER2 (numeric ranges),
484 $NUMBER:HEAD, and BASE:$NUMBER are all supported.
485 +
486 This can allow you to make partial mirrors when running fetch;
487 but is generally not recommended because history will be skipped
488 and lost.
489
490 -::
491 --stdin::
492 Only used with the 'set-tree' command.
493 +
494 Read a list of commits from stdin and commit them in reverse
495 order. Only the leading sha1 is read from each line, so
496 'git rev-list --pretty=oneline' output can be used.
497
498 --rmdir::
499 Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
500 +
501 Remove directories from the SVN tree if there are no files left
502 behind. SVN can version empty directories, and they are not
503 removed by default if there are no files left in them. git
504 cannot version empty directories. Enabling this flag will make
505 the commit to SVN act like git.
506 +
507 [verse]
508 config key: svn.rmdir
509
510 -e::
511 --edit::
512 Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
513 +
514 Edit the commit message before committing to SVN. This is off by
515 default for objects that are commits, and forced on when committing
516 tree objects.
517 +
518 [verse]
519 config key: svn.edit
520
521 -l<num>::
522 --find-copies-harder::
523 Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
524 +
525 They are both passed directly to 'git diff-tree'; see
526 linkgit:git-diff-tree[1] for more information.
527 +
528 [verse]
529 config key: svn.l
530 config key: svn.findcopiesharder
531
532 -A<filename>::
533 --authors-file=<filename>::
534 Syntax is compatible with the file used by 'git cvsimport':
535 +
536 ------------------------------------------------------------------------
537 loginname = Joe User <user@example.com>
538 ------------------------------------------------------------------------
539 +
540 If this option is specified and 'git svn' encounters an SVN
541 committer name that does not exist in the authors-file, 'git svn'
542 will abort operation. The user will then have to add the
543 appropriate entry. Re-running the previous 'git svn' command
544 after the authors-file is modified should continue operation.
545 +
546 [verse]
547 config key: svn.authorsfile
548
549 --authors-prog=<filename>::
550 If this option is specified, for each SVN committer name that
551 does not exist in the authors file, the given file is executed
552 with the committer name as the first argument. The program is
553 expected to return a single line of the form "Name <email>",
554 which will be treated as if included in the authors file.
555
556 -q::
557 --quiet::
558 Make 'git svn' less verbose. Specify a second time to make it
559 even less verbose.
560
561 --repack[=<n>]::
562 --repack-flags=<flags>::
563 These should help keep disk usage sane for large fetches with
564 many revisions.
565 +
566 --repack takes an optional argument for the number of revisions
567 to fetch before repacking. This defaults to repacking every
568 1000 commits fetched if no argument is specified.
569 +
570 --repack-flags are passed directly to 'git repack'.
571 +
572 [verse]
573 config key: svn.repack
574 config key: svn.repackflags
575
576 -m::
577 --merge::
578 -s<strategy>::
579 --strategy=<strategy>::
580 -p::
581 --preserve-merges::
582 These are only used with the 'dcommit' and 'rebase' commands.
583 +
584 Passed directly to 'git rebase' when using 'dcommit' if a
585 'git reset' cannot be used (see 'dcommit').
586
587 -n::
588 --dry-run::
589 This can be used with the 'dcommit', 'rebase', 'branch' and
590 'tag' commands.
591 +
592 For 'dcommit', print out the series of git arguments that would show
593 which diffs would be committed to SVN.
594 +
595 For 'rebase', display the local branch associated with the upstream svn
596 repository associated with the current branch and the URL of svn
597 repository that will be fetched from.
598 +
599 For 'branch' and 'tag', display the urls that will be used for copying when
600 creating the branch or tag.
601
602 --use-log-author::
603 When retrieving svn commits into git (as part of 'fetch', 'rebase', or
604 'dcommit' operations), look for the first `From:` or `Signed-off-by:` line
605 in the log message and use that as the author string.
606 --add-author-from::
607 When committing to svn from git (as part of 'commit-diff', 'set-tree' or 'dcommit'
608 operations), if the existing log message doesn't already have a
609 `From:` or `Signed-off-by:` line, append a `From:` line based on the
610 git commit's author string. If you use this, then `--use-log-author`
611 will retrieve a valid author string for all commits.
612
613
614 ADVANCED OPTIONS
615 ----------------
616
617 -i<GIT_SVN_ID>::
618 --id <GIT_SVN_ID>::
619 This sets GIT_SVN_ID (instead of using the environment). This
620 allows the user to override the default refname to fetch from
621 when tracking a single URL. The 'log' and 'dcommit' commands
622 no longer require this switch as an argument.
623
624 -R<remote name>::
625 --svn-remote <remote name>::
626 Specify the [svn-remote "<remote name>"] section to use,
627 this allows SVN multiple repositories to be tracked.
628 Default: "svn"
629
630 --follow-parent::
631 This option is only relevant if we are tracking branches (using
632 one of the repository layout options --trunk, --tags,
633 --branches, --stdlayout). For each tracked branch, try to find
634 out where its revision was copied from, and set
635 a suitable parent in the first git commit for the branch.
636 This is especially helpful when we're tracking a directory
637 that has been moved around within the repository. If this
638 feature is disabled, the branches created by 'git svn' will all
639 be linear and not share any history, meaning that there will be
640 no information on where branches were branched off or merged.
641 However, following long/convoluted histories can take a long
642 time, so disabling this feature may speed up the cloning
643 process. This feature is enabled by default, use
644 --no-follow-parent to disable it.
645 +
646 [verse]
647 config key: svn.followparent
648
649 CONFIG FILE-ONLY OPTIONS
650 ------------------------
651
652 svn.noMetadata::
653 svn-remote.<name>.noMetadata::
654 This gets rid of the 'git-svn-id:' lines at the end of every commit.
655 +
656 This option can only be used for one-shot imports as 'git svn'
657 will not be able to fetch again without metadata. Additionally,
658 if you lose your .git/svn/**/.rev_map.* files, 'git svn' will not
659 be able to rebuild them.
660 +
661 The 'git svn log' command will not work on repositories using
662 this, either. Using this conflicts with the 'useSvmProps'
663 option for (hopefully) obvious reasons.
664 +
665 This option is NOT recommended as it makes it difficult to track down
666 old references to SVN revision numbers in existing documentation, bug
667 reports and archives. If you plan to eventually migrate from SVN to git
668 and are certain about dropping SVN history, consider
669 linkgit:git-filter-branch[1] instead. filter-branch also allows
670 reformatting of metadata for ease-of-reading and rewriting authorship
671 info for non-"svn.authorsFile" users.
672
673 svn.useSvmProps::
674 svn-remote.<name>.useSvmProps::
675 This allows 'git svn' to re-map repository URLs and UUIDs from
676 mirrors created using SVN::Mirror (or svk) for metadata.
677 +
678 If an SVN revision has a property, "svm:headrev", it is likely
679 that the revision was created by SVN::Mirror (also used by SVK).
680 The property contains a repository UUID and a revision. We want
681 to make it look like we are mirroring the original URL, so
682 introduce a helper function that returns the original identity
683 URL and UUID, and use it when generating metadata in commit
684 messages.
685
686 svn.useSvnsyncProps::
687 svn-remote.<name>.useSvnsyncprops::
688 Similar to the useSvmProps option; this is for users
689 of the svnsync(1) command distributed with SVN 1.4.x and
690 later.
691
692 svn-remote.<name>.rewriteRoot::
693 This allows users to create repositories from alternate
694 URLs. For example, an administrator could run 'git svn' on the
695 server locally (accessing via file://) but wish to distribute
696 the repository with a public http:// or svn:// URL in the
697 metadata so users of it will see the public URL.
698
699 svn-remote.<name>.rewriteUUID::
700 Similar to the useSvmProps option; this is for users who need
701 to remap the UUID manually. This may be useful in situations
702 where the original UUID is not available via either useSvmProps
703 or useSvnsyncProps.
704
705 svn-remote.<name>.pushurl::
706
707 Similar to git's 'remote.<name>.pushurl', this key is designed
708 to be used in cases where 'url' points to an SVN repository
709 via a read-only transport, to provide an alternate read/write
710 transport. It is assumed that both keys point to the same
711 repository. Unlike 'commiturl', 'pushurl' is a base path. If
712 either 'commiturl' or 'pushurl' could be used, 'commiturl'
713 takes precedence.
714
715 svn.brokenSymlinkWorkaround::
716 This disables potentially expensive checks to workaround
717 broken symlinks checked into SVN by broken clients. Set this
718 option to "false" if you track a SVN repository with many
719 empty blobs that are not symlinks. This option may be changed
720 while 'git svn' is running and take effect on the next
721 revision fetched. If unset, 'git svn' assumes this option to
722 be "true".
723
724 svn.pathnameencoding::
725 This instructs git svn to recode pathnames to a given encoding.
726 It can be used by windows users and by those who work in non-utf8
727 locales to avoid corrupted file names with non-ASCII characters.
728 Valid encodings are the ones supported by Perl's Encode module.
729
730 svn-remote.<name>.automkdirs::
731 Normally, the "git svn clone" and "git svn rebase" commands
732 attempt to recreate empty directories that are in the
733 Subversion repository. If this option is set to "false", then
734 empty directories will only be created if the "git svn mkdirs"
735 command is run explicitly. If unset, 'git svn' assumes this
736 option to be "true".
737
738 Since the noMetadata, rewriteRoot, rewriteUUID, useSvnsyncProps and useSvmProps
739 options all affect the metadata generated and used by 'git svn'; they
740 *must* be set in the configuration file before any history is imported
741 and these settings should never be changed once they are set.
742
743 Additionally, only one of these options can be used per svn-remote
744 section because they affect the 'git-svn-id:' metadata line, except
745 for rewriteRoot and rewriteUUID which can be used together.
746
747
748 BASIC EXAMPLES
749 --------------
750
751 Tracking and contributing to the trunk of a Subversion-managed project
752 (ignoring tags and branches):
753
754 ------------------------------------------------------------------------
755 # Clone a repo (like git clone):
756 git svn clone http://svn.example.com/project/trunk
757 # Enter the newly cloned directory:
758 cd trunk
759 # You should be on master branch, double-check with 'git branch'
760 git branch
761 # Do some work and commit locally to git:
762 git commit ...
763 # Something is committed to SVN, rebase your local changes against the
764 # latest changes in SVN:
765 git svn rebase
766 # Now commit your changes (that were committed previously using git) to SVN,
767 # as well as automatically updating your working HEAD:
768 git svn dcommit
769 # Append svn:ignore settings to the default git exclude file:
770 git svn show-ignore >> .git/info/exclude
771 ------------------------------------------------------------------------
772
773 Tracking and contributing to an entire Subversion-managed project
774 (complete with a trunk, tags and branches):
775
776 ------------------------------------------------------------------------
777 # Clone a repo with standard SVN directory layout (like git clone):
778 git svn clone http://svn.example.com/project --stdlayout
779 # Or, if the repo uses a non-standard directory layout:
780 git svn clone http://svn.example.com/project -T tr -b branch -t tag
781 # View all branches and tags you have cloned:
782 git branch -r
783 # Create a new branch in SVN
784 git svn branch waldo
785 # Reset your master to trunk (or any other branch, replacing 'trunk'
786 # with the appropriate name):
787 git reset --hard remotes/trunk
788 # You may only dcommit to one branch/tag/trunk at a time. The usage
789 # of dcommit/rebase/show-ignore should be the same as above.
790 ------------------------------------------------------------------------
791
792 The initial 'git svn clone' can be quite time-consuming
793 (especially for large Subversion repositories). If multiple
794 people (or one person with multiple machines) want to use
795 'git svn' to interact with the same Subversion repository, you can
796 do the initial 'git svn clone' to a repository on a server and
797 have each person clone that repository with 'git clone':
798
799 ------------------------------------------------------------------------
800 # Do the initial import on a server
801 ssh server "cd /pub && git svn clone http://svn.example.com/project
802 # Clone locally - make sure the refs/remotes/ space matches the server
803 mkdir project
804 cd project
805 git init
806 git remote add origin server:/pub/project
807 git config --replace-all remote.origin.fetch '+refs/remotes/*:refs/remotes/*'
808 git fetch
809 # Prevent fetch/pull from remote git server in the future,
810 # we only want to use git svn for future updates
811 git config --remove-section remote.origin
812 # Create a local branch from one of the branches just fetched
813 git checkout -b master FETCH_HEAD
814 # Initialize 'git svn' locally (be sure to use the same URL and -T/-b/-t options as were used on server)
815 git svn init http://svn.example.com/project
816 # Pull the latest changes from Subversion
817 git svn rebase
818 ------------------------------------------------------------------------
819
820 REBASE VS. PULL/MERGE
821 ---------------------
822 Prefer to use 'git svn rebase' or 'git rebase', rather than
823 'git pull' or 'git merge' to synchronize unintegrated commits with a 'git svn'
824 branch. Doing so will keep the history of unintegrated commits linear with
825 respect to the upstream SVN repository and allow the use of the preferred
826 'git svn dcommit' subcommand to push unintegrated commits back into SVN.
827
828 Originally, 'git svn' recommended that developers pulled or merged from
829 the 'git svn' branch. This was because the author favored
830 `git svn set-tree B` to commit a single head rather than the
831 `git svn set-tree A..B` notation to commit multiple commits. Use of
832 'git pull' or 'git merge' with `git svn set-tree A..B` will cause non-linear
833 history to be flattened when committing into SVN and this can lead to merge
834 commits unexpectedly reversing previous commits in SVN.
835
836 MERGE TRACKING
837 --------------
838 While 'git svn' can track
839 copy history (including branches and tags) for repositories adopting a
840 standard layout, it cannot yet represent merge history that happened
841 inside git back upstream to SVN users. Therefore it is advised that
842 users keep history as linear as possible inside git to ease
843 compatibility with SVN (see the CAVEATS section below).
844
845 HANDLING OF SVN BRANCHES
846 ------------------------
847 If 'git svn' is configured to fetch branches (and --follow-branches
848 is in effect), it sometimes creates multiple git branches for one
849 SVN branch, where the addtional branches have names of the form
850 'branchname@nnn' (with nnn an SVN revision number). These additional
851 branches are created if 'git svn' cannot find a parent commit for the
852 first commit in an SVN branch, to connect the branch to the history of
853 the other branches.
854
855 Normally, the first commit in an SVN branch consists
856 of a copy operation. 'git svn' will read this commit to get the SVN
857 revision the branch was created from. It will then try to find the
858 git commit that corresponds to this SVN revision, and use that as the
859 parent of the branch. However, it is possible that there is no suitable
860 git commit to serve as parent. This will happen, among other reasons,
861 if the SVN branch is a copy of a revision that was not fetched by 'git
862 svn' (e.g. because it is an old revision that was skipped with
863 '--revision'), or if in SVN a directory was copied that is not tracked
864 by 'git svn' (such as a branch that is not tracked at all, or a
865 subdirectory of a tracked branch). In these cases, 'git svn' will still
866 create a git branch, but instead of using an existing git commit as the
867 parent of the branch, it will read the SVN history of the directory the
868 branch was copied from and create appropriate git commits. This is
869 indicated by the message "Initializing parent: <branchname>".
870
871 Additionally, it will create a special branch named
872 '<branchname>@<SVN-Revision>', where <SVN-Revision> is the SVN revision
873 number the branch was copied from. This branch will point to the newly
874 created parent commit of the branch. If in SVN the branch was deleted
875 and later recreated from a different version, there will be multiple
876 such branches with an '@'.
877
878 Note that this may mean that multiple git commits are created for a
879 single SVN revision.
880
881 An example: in an SVN repository with a standard
882 trunk/tags/branches layout, a directory trunk/sub is created in r.100.
883 In r.200, trunk/sub is branched by copying it to branches/. 'git svn
884 clone -s' will then create a branch 'sub'. It will also create new git
885 commits for r.100 through r.199 and use these as the history of branch
886 'sub'. Thus there will be two git commits for each revision from r.100
887 to r.199 (one containing trunk/, one containing trunk/sub/). Finally,
888 it will create a branch 'sub@200' pointing to the new parent commit of
889 branch 'sub' (i.e. the commit for r.200 and trunk/sub/).
890
891 CAVEATS
892 -------
893
894 For the sake of simplicity and interoperating with Subversion,
895 it is recommended that all 'git svn' users clone, fetch and dcommit
896 directly from the SVN server, and avoid all 'git clone'/'pull'/'merge'/'push'
897 operations between git repositories and branches. The recommended
898 method of exchanging code between git branches and users is
899 'git format-patch' and 'git am', or just 'dcommit'ing to the SVN repository.
900
901 Running 'git merge' or 'git pull' is NOT recommended on a branch you
902 plan to 'dcommit' from because Subversion users cannot see any
903 merges you've made. Furthermore, if you merge or pull from a git branch
904 that is a mirror of an SVN branch, 'dcommit' may commit to the wrong
905 branch.
906
907 If you do merge, note the following rule: 'git svn dcommit' will
908 attempt to commit on top of the SVN commit named in
909 ------------------------------------------------------------------------
910 git log --grep=^git-svn-id: --first-parent -1
911 ------------------------------------------------------------------------
912 You 'must' therefore ensure that the most recent commit of the branch
913 you want to dcommit to is the 'first' parent of the merge. Chaos will
914 ensue otherwise, especially if the first parent is an older commit on
915 the same SVN branch.
916
917 'git clone' does not clone branches under the refs/remotes/ hierarchy or
918 any 'git svn' metadata, or config. So repositories created and managed with
919 using 'git svn' should use 'rsync' for cloning, if cloning is to be done
920 at all.
921
922 Since 'dcommit' uses rebase internally, any git branches you 'git push' to
923 before 'dcommit' on will require forcing an overwrite of the existing ref
924 on the remote repository. This is generally considered bad practice,
925 see the linkgit:git-push[1] documentation for details.
926
927 Do not use the --amend option of linkgit:git-commit[1] on a change you've
928 already dcommitted. It is considered bad practice to --amend commits
929 you've already pushed to a remote repository for other users, and
930 dcommit with SVN is analogous to that.
931
932 When cloning an SVN repository, if none of the options for describing
933 the repository layout is used (--trunk, --tags, --branches,
934 --stdlayout), 'git svn clone' will create a git repository with
935 completely linear history, where branches and tags appear as separate
936 directories in the working copy. While this is the easiest way to get a
937 copy of a complete repository, for projects with many branches it will
938 lead to a working copy many times larger than just the trunk. Thus for
939 projects using the standard directory structure (trunk/branches/tags),
940 it is recommended to clone with option '--stdlayout'. If the project
941 uses a non-standard structure, and/or if branches and tags are not
942 required, it is easiest to only clone one directory (typically trunk),
943 without giving any repository layout options. If the full history with
944 branches and tags is required, the options '--trunk' / '--branches' /
945 '--tags' must be used.
946
947 When using multiple --branches or --tags, 'git svn' does not automatically
948 handle name collisions (for example, if two branches from different paths have
949 the same name, or if a branch and a tag have the same name). In these cases,
950 use 'init' to set up your git repository then, before your first 'fetch', edit
951 the .git/config file so that the branches and tags are associated with
952 different name spaces. For example:
953
954 branches = stable/*:refs/remotes/svn/stable/*
955 branches = debug/*:refs/remotes/svn/debug/*
956
957 BUGS
958 ----
959
960 We ignore all SVN properties except svn:executable. Any unhandled
961 properties are logged to $GIT_DIR/svn/<refname>/unhandled.log
962
963 Renamed and copied directories are not detected by git and hence not
964 tracked when committing to SVN. I do not plan on adding support for
965 this as it's quite difficult and time-consuming to get working for all
966 the possible corner cases (git doesn't do it, either). Committing
967 renamed and copied files is fully supported if they're similar enough
968 for git to detect them.
969
970 In SVN, it is possible (though discouraged) to commit changes to a tag
971 (because a tag is just a directory copy, thus technically the same as a
972 branch). When cloning an SVN repository, 'git svn' cannot know if such a
973 commit to a tag will happen in the future. Thus it acts conservatively
974 and imports all SVN tags as branches, prefixing the tag name with 'tags/'.
975
976 CONFIGURATION
977 -------------
978
979 'git svn' stores [svn-remote] configuration information in the
980 repository .git/config file. It is similar the core git
981 [remote] sections except 'fetch' keys do not accept glob
982 arguments; but they are instead handled by the 'branches'
983 and 'tags' keys. Since some SVN repositories are oddly
984 configured with multiple projects glob expansions such those
985 listed below are allowed:
986
987 ------------------------------------------------------------------------
988 [svn-remote "project-a"]
989 url = http://server.org/svn
990 fetch = trunk/project-a:refs/remotes/project-a/trunk
991 branches = branches/*/project-a:refs/remotes/project-a/branches/*
992 tags = tags/*/project-a:refs/remotes/project-a/tags/*
993 ------------------------------------------------------------------------
994
995 Keep in mind that the '\*' (asterisk) wildcard of the local ref
996 (right of the ':') *must* be the farthest right path component;
997 however the remote wildcard may be anywhere as long as it's an
998 independent path component (surrounded by '/' or EOL). This
999 type of configuration is not automatically created by 'init' and
1000 should be manually entered with a text-editor or using 'git config'.
1001
1002 It is also possible to fetch a subset of branches or tags by using a
1003 comma-separated list of names within braces. For example:
1004
1005 ------------------------------------------------------------------------
1006 [svn-remote "huge-project"]
1007 url = http://server.org/svn
1008 fetch = trunk/src:refs/remotes/trunk
1009 branches = branches/{red,green}/src:refs/remotes/branches/*
1010 tags = tags/{1.0,2.0}/src:refs/remotes/tags/*
1011 ------------------------------------------------------------------------
1012
1013 Note that git-svn keeps track of the highest revision in which a branch
1014 or tag has appeared. If the subset of branches or tags is changed after
1015 fetching, then .git/svn/.metadata must be manually edited to remove (or
1016 reset) branches-maxRev and/or tags-maxRev as appropriate.
1017
1018 SEE ALSO
1019 --------
1020 linkgit:git-rebase[1]
1021
1022 GIT
1023 ---
1024 Part of the linkgit:git[1] suite