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