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