Code

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