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 This option is not recommended, please read the 'svn.noMetadata'
60 section of this manpage before using this option.
61 --use-svm-props;;
62 Set the 'useSvmProps' option in the [svn-remote] config.
63 --use-svnsync-props;;
64 Set the 'useSvnsyncProps' option in the [svn-remote] config.
65 --rewrite-root=<URL>;;
66 Set the 'rewriteRoot' option in the [svn-remote] config.
67 --rewrite-uuid=<UUID>;;
68 Set the 'rewriteUUID' option in the [svn-remote] config.
69 --username=<user>;;
70 For transports that SVN handles authentication for (http,
71 https, and plain svn), specify the username. For other
72 transports (eg svn+ssh://), you must include the username in
73 the URL, eg svn+ssh://foo@svn.bar.com/project
74 --prefix=<prefix>;;
75 This allows one to specify a prefix which is prepended
76 to the names of remotes if trunk/branches/tags are
77 specified. The prefix does not automatically include a
78 trailing slash, so be sure you include one in the
79 argument if that is what you want. If --branches/-b is
80 specified, the prefix must include a trailing slash.
81 Setting a prefix is useful if you wish to track multiple
82 projects that share a common repository.
83 --ignore-paths=<regex>;;
84 When passed to 'init' or 'clone' this regular expression will
85 be preserved as a config key. See 'fetch' for a description
86 of '--ignore-paths'.
87 --no-minimize-url;;
88 When tracking multiple directories (using --stdlayout,
89 --branches, or --tags options), git svn will attempt to connect
90 to the root (or highest allowed level) of the Subversion
91 repository. This default allows better tracking of history if
92 entire projects are moved within a repository, but may cause
93 issues on repositories where read access restrictions are in
94 place. Passing '--no-minimize-url' will allow git svn to
95 accept URLs as-is without attempting to connect to a higher
96 level directory. This option is off by default when only
97 one URL/branch is tracked (it would do little good).
99 'fetch'::
100 Fetch unfetched revisions from the Subversion remote we are
101 tracking. The name of the [svn-remote "..."] section in the
102 .git/config file may be specified as an optional command-line
103 argument.
105 --localtime;;
106 Store Git commit times in the local timezone instead of UTC. This
107 makes 'git log' (even without --date=local) show the same times
108 that `svn log` would in the local timezone.
109 +
110 This doesn't interfere with interoperating with the Subversion
111 repository you cloned from, but if you wish for your local Git
112 repository to be able to interoperate with someone else's local Git
113 repository, either don't use this option or you should both use it in
114 the same local timezone.
116 --parent;;
117 Fetch only from the SVN parent of the current HEAD.
119 --ignore-paths=<regex>;;
120 This allows one to specify a Perl regular expression that will
121 cause skipping of all matching paths from checkout from SVN.
122 The '--ignore-paths' option should match for every 'fetch'
123 (including automatic fetches due to 'clone', 'dcommit',
124 'rebase', etc) on a given repository.
125 +
126 [verse]
127 config key: svn-remote.<name>.ignore-paths
128 +
129 If the ignore-paths config key is set and the command line option is
130 also given, both regular expressions will be used.
131 +
132 Examples:
133 +
134 --
135 Skip "doc*" directory for every fetch;;
136 +
137 ------------------------------------------------------------------------
138 --ignore-paths="^doc"
139 ------------------------------------------------------------------------
141 Skip "branches" and "tags" of first level directories;;
142 +
143 ------------------------------------------------------------------------
144 --ignore-paths="^[^/]+/(?:branches|tags)"
145 ------------------------------------------------------------------------
146 --
148 --use-log-author;;
149 When retrieving svn commits into git (as part of fetch, rebase, or
150 dcommit operations), look for the first From: or Signed-off-by: line
151 in the log message and use that as the author string.
152 --add-author-from;;
153 When committing to svn from git (as part of commit or dcommit
154 operations), if the existing log message doesn't already have a
155 From: or Signed-off-by: line, append a From: line based on the
156 git commit's author string. If you use this, then --use-log-author
157 will retrieve a valid author string for all commits.
159 'clone'::
160 Runs 'init' and 'fetch'. It will automatically create a
161 directory based on the basename of the URL passed to it;
162 or if a second argument is passed; it will create a directory
163 and work within that. It accepts all arguments that the
164 'init' and 'fetch' commands accept; with the exception of
165 '--fetch-all' and '--parent'. After a repository is cloned,
166 the 'fetch' command will be able to update revisions without
167 affecting the working tree; and the 'rebase' command will be
168 able to update the working tree with the latest changes.
170 'rebase'::
171 This fetches revisions from the SVN parent of the current HEAD
172 and rebases the current (uncommitted to SVN) work against it.
173 +
174 This works similarly to `svn update` or 'git pull' except that
175 it preserves linear history with 'git rebase' instead of
176 'git merge' for ease of dcommitting with 'git svn'.
177 +
178 This accepts all options that 'git svn fetch' and 'git rebase'
179 accept. However, '--fetch-all' only fetches from the current
180 [svn-remote], and not all [svn-remote] definitions.
181 +
182 Like 'git rebase'; this requires that the working tree be clean
183 and have no uncommitted changes.
185 -l;;
186 --local;;
187 Do not fetch remotely; only run 'git rebase' against the
188 last fetched commit from the upstream SVN.
190 'dcommit'::
191 Commit each diff from a specified head directly to the SVN
192 repository, and then rebase or reset (depending on whether or
193 not there is a diff between SVN and head). This will create
194 a revision in SVN for each commit in git.
195 It is recommended that you run 'git svn' fetch and rebase (not
196 pull or merge) your commits against the latest changes in the
197 SVN repository.
198 An optional revision or branch argument may be specified, and
199 causes 'git svn' to do all work on that revision/branch
200 instead of HEAD.
201 This is advantageous over 'set-tree' (below) because it produces
202 cleaner, more linear history.
203 +
204 --no-rebase;;
205 After committing, do not rebase or reset.
206 --commit-url <URL>;;
207 Commit to this SVN URL (the full path). This is intended to
208 allow existing 'git svn' repositories created with one transport
209 method (e.g. `svn://` or `http://` for anonymous read) to be
210 reused if a user is later given access to an alternate transport
211 method (e.g. `svn+ssh://` or `https://`) for commit.
212 +
213 [verse]
214 config key: svn-remote.<name>.commiturl
215 config key: svn.commiturl (overwrites all svn-remote.<name>.commiturl options)
216 +
217 Using this option for any other purpose (don't ask) is very strongly
218 discouraged.
220 --mergeinfo=<mergeinfo>;;
221 Add the given merge information during the dcommit
222 (e.g. `--mergeinfo="/branches/foo:1-10"`). All svn server versions can
223 store this information (as a property), and svn clients starting from
224 version 1.5 can make use of it. 'git svn' currently does not use it
225 and does not set it automatically.
227 'branch'::
228 Create a branch in the SVN repository.
230 -m;;
231 --message;;
232 Allows to specify the commit message.
234 -t;;
235 --tag;;
236 Create a tag by using the tags_subdir instead of the branches_subdir
237 specified during git svn init.
239 -d;;
240 --destination;;
241 If more than one --branches (or --tags) option was given to the 'init'
242 or 'clone' command, you must provide the location of the branch (or
243 tag) you wish to create in the SVN repository. The value of this
244 option must match one of the paths specified by a --branches (or
245 --tags) option. You can see these paths with the commands
246 +
247 git config --get-all svn-remote.<name>.branches
248 git config --get-all svn-remote.<name>.tags
249 +
250 where <name> is the name of the SVN repository as specified by the -R option to
251 'init' (or "svn" by default).
253 --username;;
254 Specify the SVN username to perform the commit as. This option overrides
255 the 'username' configuration property.
257 --commit-url;;
258 Use the specified URL to connect to the destination Subversion
259 repository. This is useful in cases where the source SVN
260 repository is read-only. This option overrides configuration
261 property 'commiturl'.
262 +
263 git config --get-all svn-remote.<name>.commiturl
264 +
266 'tag'::
267 Create a tag in the SVN repository. This is a shorthand for
268 'branch -t'.
270 'log'::
271 This should make it easy to look up svn log messages when svn
272 users refer to -r/--revision numbers.
273 +
274 The following features from `svn log' are supported:
275 +
276 --
277 -r <n>[:<n>];;
278 --revision=<n>[:<n>];;
279 is supported, non-numeric args are not:
280 HEAD, NEXT, BASE, PREV, etc ...
281 -v;;
282 --verbose;;
283 it's not completely compatible with the --verbose
284 output in svn log, but reasonably close.
285 --limit=<n>;;
286 is NOT the same as --max-count, doesn't count
287 merged/excluded commits
288 --incremental;;
289 supported
290 --
291 +
292 New features:
293 +
294 --
295 --show-commit;;
296 shows the git commit sha1, as well
297 --oneline;;
298 our version of --pretty=oneline
299 --
300 +
301 NOTE: SVN itself only stores times in UTC and nothing else. The regular svn
302 client converts the UTC time to the local time (or based on the TZ=
303 environment). This command has the same behaviour.
304 +
305 Any other arguments are passed directly to 'git log'
307 'blame'::
308 Show what revision and author last modified each line of a file. The
309 output of this mode is format-compatible with the output of
310 `svn blame' by default. Like the SVN blame command,
311 local uncommitted changes in the working copy are ignored;
312 the version of the file in the HEAD revision is annotated. Unknown
313 arguments are passed directly to 'git blame'.
314 +
315 --git-format;;
316 Produce output in the same format as 'git blame', but with
317 SVN revision numbers instead of git commit hashes. In this mode,
318 changes that haven't been committed to SVN (including local
319 working-copy edits) are shown as revision 0.
321 'find-rev'::
322 When given an SVN revision number of the form 'rN', returns the
323 corresponding git commit hash (this can optionally be followed by a
324 tree-ish to specify which branch should be searched). When given a
325 tree-ish, returns the corresponding SVN revision number.
327 'set-tree'::
328 You should consider using 'dcommit' instead of this command.
329 Commit specified commit or tree objects to SVN. This relies on
330 your imported fetch data being up-to-date. This makes
331 absolutely no attempts to do patching when committing to SVN, it
332 simply overwrites files with those specified in the tree or
333 commit. All merging is assumed to have taken place
334 independently of 'git svn' functions.
336 'create-ignore'::
337 Recursively finds the svn:ignore property on directories and
338 creates matching .gitignore files. The resulting files are staged to
339 be committed, but are not committed. Use -r/--revision to refer to a
340 specific revision.
342 'show-ignore'::
343 Recursively finds and lists the svn:ignore property on
344 directories. The output is suitable for appending to
345 the $GIT_DIR/info/exclude file.
347 'mkdirs'::
348 Attempts to recreate empty directories that core git cannot track
349 based on information in $GIT_DIR/svn/<refname>/unhandled.log files.
350 Empty directories are automatically recreated when using
351 "git svn clone" and "git svn rebase", so "mkdirs" is intended
352 for use after commands like "git checkout" or "git reset".
354 'commit-diff'::
355 Commits the diff of two tree-ish arguments from the
356 command-line. This command does not rely on being inside an `git svn
357 init`-ed repository. This command takes three arguments, (a) the
358 original tree to diff against, (b) the new tree result, (c) the
359 URL of the target Subversion repository. The final argument
360 (URL) may be omitted if you are working from a 'git svn'-aware
361 repository (that has been `init`-ed with 'git svn').
362 The -r<revision> option is required for this.
364 'info'::
365 Shows information about a file or directory similar to what
366 `svn info' provides. Does not currently support a -r/--revision
367 argument. Use the --url option to output only the value of the
368 'URL:' field.
370 'proplist'::
371 Lists the properties stored in the Subversion repository about a
372 given file or directory. Use -r/--revision to refer to a specific
373 Subversion revision.
375 'propget'::
376 Gets the Subversion property given as the first argument, for a
377 file. A specific revision can be specified with -r/--revision.
379 'show-externals'::
380 Shows the Subversion externals. Use -r/--revision to specify a
381 specific revision.
383 'gc'::
384 Compress $GIT_DIR/svn/<refname>/unhandled.log files in .git/svn
385 and remove $GIT_DIR/svn/<refname>index files in .git/svn.
387 'reset'::
388 Undoes the effects of 'fetch' back to the specified revision.
389 This allows you to re-'fetch' an SVN revision. Normally the
390 contents of an SVN revision should never change and 'reset'
391 should not be necessary. However, if SVN permissions change,
392 or if you alter your --ignore-paths option, a 'fetch' may fail
393 with "not found in commit" (file not previously visible) or
394 "checksum mismatch" (missed a modification). If the problem
395 file cannot be ignored forever (with --ignore-paths) the only
396 way to repair the repo is to use 'reset'.
397 +
398 Only the rev_map and refs/remotes/git-svn are changed. Follow 'reset'
399 with a 'fetch' and then 'git reset' or 'git rebase' to move local
400 branches onto the new tree.
402 -r <n>;;
403 --revision=<n>;;
404 Specify the most recent revision to keep. All later revisions
405 are discarded.
406 -p;;
407 --parent;;
408 Discard the specified revision as well, keeping the nearest
409 parent instead.
410 Example:;;
411 Assume you have local changes in "master", but you need to refetch "r2".
412 +
413 ------------
414 r1---r2---r3 remotes/git-svn
415 \
416 A---B master
417 ------------
418 +
419 Fix the ignore-paths or SVN permissions problem that caused "r2" to
420 be incomplete in the first place. Then:
421 +
422 [verse]
423 git svn reset -r2 -p
424 git svn fetch
425 +
426 ------------
427 r1---r2'--r3' remotes/git-svn
428 \
429 r2---r3---A---B master
430 ------------
431 +
432 Then fixup "master" with 'git rebase'.
433 Do NOT use 'git merge' or your history will not be compatible with a
434 future 'dcommit'!
435 +
436 [verse]
437 git rebase --onto remotes/git-svn A^ master
438 +
439 ------------
440 r1---r2'--r3' remotes/git-svn
441 \
442 A'--B' master
443 ------------
445 OPTIONS
446 -------
448 --shared[=(false|true|umask|group|all|world|everybody)]::
449 --template=<template_directory>::
450 Only used with the 'init' command.
451 These are passed directly to 'git init'.
453 -r <arg>::
454 --revision <arg>::
455 Used with the 'fetch' command.
456 +
457 This allows revision ranges for partial/cauterized history
458 to be supported. $NUMBER, $NUMBER1:$NUMBER2 (numeric ranges),
459 $NUMBER:HEAD, and BASE:$NUMBER are all supported.
460 +
461 This can allow you to make partial mirrors when running fetch;
462 but is generally not recommended because history will be skipped
463 and lost.
465 -::
466 --stdin::
467 Only used with the 'set-tree' command.
468 +
469 Read a list of commits from stdin and commit them in reverse
470 order. Only the leading sha1 is read from each line, so
471 'git rev-list --pretty=oneline' output can be used.
473 --rmdir::
474 Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
475 +
476 Remove directories from the SVN tree if there are no files left
477 behind. SVN can version empty directories, and they are not
478 removed by default if there are no files left in them. git
479 cannot version empty directories. Enabling this flag will make
480 the commit to SVN act like git.
481 +
482 [verse]
483 config key: svn.rmdir
485 -e::
486 --edit::
487 Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
488 +
489 Edit the commit message before committing to SVN. This is off by
490 default for objects that are commits, and forced on when committing
491 tree objects.
492 +
493 [verse]
494 config key: svn.edit
496 -l<num>::
497 --find-copies-harder::
498 Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
499 +
500 They are both passed directly to 'git diff-tree'; see
501 linkgit:git-diff-tree[1] for more information.
502 +
503 [verse]
504 config key: svn.l
505 config key: svn.findcopiesharder
507 -A<filename>::
508 --authors-file=<filename>::
509 Syntax is compatible with the file used by 'git cvsimport':
510 +
511 ------------------------------------------------------------------------
512 loginname = Joe User <user@example.com>
513 ------------------------------------------------------------------------
514 +
515 If this option is specified and 'git svn' encounters an SVN
516 committer name that does not exist in the authors-file, 'git svn'
517 will abort operation. The user will then have to add the
518 appropriate entry. Re-running the previous 'git svn' command
519 after the authors-file is modified should continue operation.
520 +
521 [verse]
522 config key: svn.authorsfile
524 --authors-prog=<filename>::
525 If this option is specified, for each SVN committer name that
526 does not exist in the authors file, the given file is executed
527 with the committer name as the first argument. The program is
528 expected to return a single line of the form "Name <email>",
529 which will be treated as if included in the authors file.
531 -q::
532 --quiet::
533 Make 'git svn' less verbose. Specify a second time to make it
534 even less verbose.
536 --repack[=<n>]::
537 --repack-flags=<flags>::
538 These should help keep disk usage sane for large fetches with
539 many revisions.
540 +
541 --repack takes an optional argument for the number of revisions
542 to fetch before repacking. This defaults to repacking every
543 1000 commits fetched if no argument is specified.
544 +
545 --repack-flags are passed directly to 'git repack'.
546 +
547 [verse]
548 config key: svn.repack
549 config key: svn.repackflags
551 -m::
552 --merge::
553 -s<strategy>::
554 --strategy=<strategy>::
555 These are only used with the 'dcommit' and 'rebase' commands.
556 +
557 Passed directly to 'git rebase' when using 'dcommit' if a
558 'git reset' cannot be used (see 'dcommit').
560 -n::
561 --dry-run::
562 This can be used with the 'dcommit', 'rebase', 'branch' and
563 'tag' commands.
564 +
565 For 'dcommit', print out the series of git arguments that would show
566 which diffs would be committed to SVN.
567 +
568 For 'rebase', display the local branch associated with the upstream svn
569 repository associated with the current branch and the URL of svn
570 repository that will be fetched from.
571 +
572 For 'branch' and 'tag', display the urls that will be used for copying when
573 creating the branch or tag.
576 ADVANCED OPTIONS
577 ----------------
579 -i<GIT_SVN_ID>::
580 --id <GIT_SVN_ID>::
581 This sets GIT_SVN_ID (instead of using the environment). This
582 allows the user to override the default refname to fetch from
583 when tracking a single URL. The 'log' and 'dcommit' commands
584 no longer require this switch as an argument.
586 -R<remote name>::
587 --svn-remote <remote name>::
588 Specify the [svn-remote "<remote name>"] section to use,
589 this allows SVN multiple repositories to be tracked.
590 Default: "svn"
592 --follow-parent::
593 This is especially helpful when we're tracking a directory
594 that has been moved around within the repository, or if we
595 started tracking a branch and never tracked the trunk it was
596 descended from. This feature is enabled by default, use
597 --no-follow-parent to disable it.
598 +
599 [verse]
600 config key: svn.followparent
602 CONFIG FILE-ONLY OPTIONS
603 ------------------------
605 svn.noMetadata::
606 svn-remote.<name>.noMetadata::
607 This gets rid of the 'git-svn-id:' lines at the end of every commit.
608 +
609 This option can only be used for one-shot imports as 'git svn'
610 will not be able to fetch again without metadata. Additionally,
611 if you lose your .git/svn/**/.rev_map.* files, 'git svn' will not
612 be able to rebuild them.
613 +
614 The 'git svn log' command will not work on repositories using
615 this, either. Using this conflicts with the 'useSvmProps'
616 option for (hopefully) obvious reasons.
617 +
618 This option is NOT recommended as it makes it difficult to track down
619 old references to SVN revision numbers in existing documentation, bug
620 reports and archives. If you plan to eventually migrate from SVN to git
621 and are certain about dropping SVN history, consider
622 linkgit:git-filter-branch[1] instead. filter-branch also allows
623 reformatting of metadata for ease-of-reading and rewriting authorship
624 info for non-"svn.authorsFile" users.
626 svn.useSvmProps::
627 svn-remote.<name>.useSvmProps::
628 This allows 'git svn' to re-map repository URLs and UUIDs from
629 mirrors created using SVN::Mirror (or svk) for metadata.
630 +
631 If an SVN revision has a property, "svm:headrev", it is likely
632 that the revision was created by SVN::Mirror (also used by SVK).
633 The property contains a repository UUID and a revision. We want
634 to make it look like we are mirroring the original URL, so
635 introduce a helper function that returns the original identity
636 URL and UUID, and use it when generating metadata in commit
637 messages.
639 svn.useSvnsyncProps::
640 svn-remote.<name>.useSvnsyncprops::
641 Similar to the useSvmProps option; this is for users
642 of the svnsync(1) command distributed with SVN 1.4.x and
643 later.
645 svn-remote.<name>.rewriteRoot::
646 This allows users to create repositories from alternate
647 URLs. For example, an administrator could run 'git svn' on the
648 server locally (accessing via file://) but wish to distribute
649 the repository with a public http:// or svn:// URL in the
650 metadata so users of it will see the public URL.
652 svn-remote.<name>.rewriteUUID::
653 Similar to the useSvmProps option; this is for users who need
654 to remap the UUID manually. This may be useful in situations
655 where the original UUID is not available via either useSvmProps
656 or useSvnsyncProps.
658 svn.brokenSymlinkWorkaround::
659 This disables potentially expensive checks to workaround
660 broken symlinks checked into SVN by broken clients. Set this
661 option to "false" if you track a SVN repository with many
662 empty blobs that are not symlinks. This option may be changed
663 while 'git svn' is running and take effect on the next
664 revision fetched. If unset, 'git svn' assumes this option to
665 be "true".
667 svn.pathnameencoding::
668 This instructs git svn to recode pathnames to a given encoding.
669 It can be used by windows users and by those who work in non-utf8
670 locales to avoid corrupted file names with non-ASCII characters.
671 Valid encodings are the ones supported by Perl's Encode module.
673 Since the noMetadata, rewriteRoot, rewriteUUID, useSvnsyncProps and useSvmProps
674 options all affect the metadata generated and used by 'git svn'; they
675 *must* be set in the configuration file before any history is imported
676 and these settings should never be changed once they are set.
678 Additionally, only one of these options can be used per svn-remote
679 section because they affect the 'git-svn-id:' metadata line, except
680 for rewriteRoot and rewriteUUID which can be used together.
683 BASIC EXAMPLES
684 --------------
686 Tracking and contributing to the trunk of a Subversion-managed project:
688 ------------------------------------------------------------------------
689 # Clone a repo (like git clone):
690 git svn clone http://svn.example.com/project/trunk
691 # Enter the newly cloned directory:
692 cd trunk
693 # You should be on master branch, double-check with 'git branch'
694 git branch
695 # Do some work and commit locally to git:
696 git commit ...
697 # Something is committed to SVN, rebase your local changes against the
698 # latest changes in SVN:
699 git svn rebase
700 # Now commit your changes (that were committed previously using git) to SVN,
701 # as well as automatically updating your working HEAD:
702 git svn dcommit
703 # Append svn:ignore settings to the default git exclude file:
704 git svn show-ignore >> .git/info/exclude
705 ------------------------------------------------------------------------
707 Tracking and contributing to an entire Subversion-managed project
708 (complete with a trunk, tags and branches):
710 ------------------------------------------------------------------------
711 # Clone a repo (like git clone):
712 git svn clone http://svn.example.com/project -T trunk -b branches -t tags
713 # View all branches and tags you have cloned:
714 git branch -r
715 # Create a new branch in SVN
716 git svn branch waldo
717 # Reset your master to trunk (or any other branch, replacing 'trunk'
718 # with the appropriate name):
719 git reset --hard remotes/trunk
720 # You may only dcommit to one branch/tag/trunk at a time. The usage
721 # of dcommit/rebase/show-ignore should be the same as above.
722 ------------------------------------------------------------------------
724 The initial 'git svn clone' can be quite time-consuming
725 (especially for large Subversion repositories). If multiple
726 people (or one person with multiple machines) want to use
727 'git svn' to interact with the same Subversion repository, you can
728 do the initial 'git svn clone' to a repository on a server and
729 have each person clone that repository with 'git clone':
731 ------------------------------------------------------------------------
732 # Do the initial import on a server
733 ssh server "cd /pub && git svn clone http://svn.example.com/project
734 # Clone locally - make sure the refs/remotes/ space matches the server
735 mkdir project
736 cd project
737 git init
738 git remote add origin server:/pub/project
739 git config --replace-all remote.origin.fetch '+refs/remotes/*:refs/remotes/*'
740 git fetch
741 # Prevent fetch/pull from remote git server in the future,
742 # we only want to use git svn for future updates
743 git config --remove-section remote.origin
744 # Create a local branch from one of the branches just fetched
745 git checkout -b master FETCH_HEAD
746 # Initialize 'git svn' locally (be sure to use the same URL and -T/-b/-t options as were used on server)
747 git svn init http://svn.example.com/project
748 # Pull the latest changes from Subversion
749 git svn rebase
750 ------------------------------------------------------------------------
752 REBASE VS. PULL/MERGE
753 ---------------------
755 Originally, 'git svn' recommended that the 'remotes/git-svn' branch be
756 pulled or merged from. This is because the author favored
757 `git svn set-tree B` to commit a single head rather than the
758 `git svn set-tree A..B` notation to commit multiple commits.
760 If you use `git svn set-tree A..B` to commit several diffs and you do
761 not have the latest remotes/git-svn merged into my-branch, you should
762 use `git svn rebase` to update your work branch instead of `git pull` or
763 `git merge`. `pull`/`merge` can cause non-linear history to be flattened
764 when committing into SVN, which can lead to merge commits reversing
765 previous commits in SVN.
767 DESIGN PHILOSOPHY
768 -----------------
769 Merge tracking in Subversion is lacking and doing branched development
770 with Subversion can be cumbersome as a result. While 'git svn' can track
771 copy history (including branches and tags) for repositories adopting a
772 standard layout, it cannot yet represent merge history that happened
773 inside git back upstream to SVN users. Therefore it is advised that
774 users keep history as linear as possible inside git to ease
775 compatibility with SVN (see the CAVEATS section below).
777 CAVEATS
778 -------
780 For the sake of simplicity and interoperating with a less-capable system
781 (SVN), it is recommended that all 'git svn' users clone, fetch and dcommit
782 directly from the SVN server, and avoid all 'git clone'/'pull'/'merge'/'push'
783 operations between git repositories and branches. The recommended
784 method of exchanging code between git branches and users is
785 'git format-patch' and 'git am', or just 'dcommit'ing to the SVN repository.
787 Running 'git merge' or 'git pull' is NOT recommended on a branch you
788 plan to 'dcommit' from. Subversion does not represent merges in any
789 reasonable or useful fashion; so users using Subversion cannot see any
790 merges you've made. Furthermore, if you merge or pull from a git branch
791 that is a mirror of an SVN branch, 'dcommit' may commit to the wrong
792 branch.
794 If you do merge, note the following rule: 'git svn dcommit' will
795 attempt to commit on top of the SVN commit named in
796 ------------------------------------------------------------------------
797 git log --grep=^git-svn-id: --first-parent -1
798 ------------------------------------------------------------------------
799 You 'must' therefore ensure that the most recent commit of the branch
800 you want to dcommit to is the 'first' parent of the merge. Chaos will
801 ensue otherwise, especially if the first parent is an older commit on
802 the same SVN branch.
804 'git clone' does not clone branches under the refs/remotes/ hierarchy or
805 any 'git svn' metadata, or config. So repositories created and managed with
806 using 'git svn' should use 'rsync' for cloning, if cloning is to be done
807 at all.
809 Since 'dcommit' uses rebase internally, any git branches you 'git push' to
810 before 'dcommit' on will require forcing an overwrite of the existing ref
811 on the remote repository. This is generally considered bad practice,
812 see the linkgit:git-push[1] documentation for details.
814 Do not use the --amend option of linkgit:git-commit[1] on a change you've
815 already dcommitted. It is considered bad practice to --amend commits
816 you've already pushed to a remote repository for other users, and
817 dcommit with SVN is analogous to that.
819 When using multiple --branches or --tags, 'git svn' does not automatically
820 handle name collisions (for example, if two branches from different paths have
821 the same name, or if a branch and a tag have the same name). In these cases,
822 use 'init' to set up your git repository then, before your first 'fetch', edit
823 the .git/config file so that the branches and tags are associated with
824 different name spaces. For example:
826 branches = stable/*:refs/remotes/svn/stable/*
827 branches = debug/*:refs/remotes/svn/debug/*
829 BUGS
830 ----
832 We ignore all SVN properties except svn:executable. Any unhandled
833 properties are logged to $GIT_DIR/svn/<refname>/unhandled.log
835 Renamed and copied directories are not detected by git and hence not
836 tracked when committing to SVN. I do not plan on adding support for
837 this as it's quite difficult and time-consuming to get working for all
838 the possible corner cases (git doesn't do it, either). Committing
839 renamed and copied files are fully supported if they're similar enough
840 for git to detect them.
842 CONFIGURATION
843 -------------
845 'git svn' stores [svn-remote] configuration information in the
846 repository .git/config file. It is similar the core git
847 [remote] sections except 'fetch' keys do not accept glob
848 arguments; but they are instead handled by the 'branches'
849 and 'tags' keys. Since some SVN repositories are oddly
850 configured with multiple projects glob expansions such those
851 listed below are allowed:
853 ------------------------------------------------------------------------
854 [svn-remote "project-a"]
855 url = http://server.org/svn
856 fetch = trunk/project-a:refs/remotes/project-a/trunk
857 branches = branches/*/project-a:refs/remotes/project-a/branches/*
858 tags = tags/*/project-a:refs/remotes/project-a/tags/*
859 ------------------------------------------------------------------------
861 Keep in mind that the '\*' (asterisk) wildcard of the local ref
862 (right of the ':') *must* be the farthest right path component;
863 however the remote wildcard may be anywhere as long as it's an
864 independent path component (surrounded by '/' or EOL). This
865 type of configuration is not automatically created by 'init' and
866 should be manually entered with a text-editor or using 'git config'.
868 It is also possible to fetch a subset of branches or tags by using a
869 comma-separated list of names within braces. For example:
871 ------------------------------------------------------------------------
872 [svn-remote "huge-project"]
873 url = http://server.org/svn
874 fetch = trunk/src:refs/remotes/trunk
875 branches = branches/{red,green}/src:refs/remotes/branches/*
876 tags = tags/{1.0,2.0}/src:refs/remotes/tags/*
877 ------------------------------------------------------------------------
879 Note that git-svn keeps track of the highest revision in which a branch
880 or tag has appeared. If the subset of branches or tags is changed after
881 fetching, then .git/svn/.metadata must be manually edited to remove (or
882 reset) branches-maxRev and/or tags-maxRev as appropriate.
884 SEE ALSO
885 --------
886 linkgit:git-rebase[1]
888 Author
889 ------
890 Written by Eric Wong <normalperson@yhbt.net>.
892 Documentation
893 -------------
894 Written by Eric Wong <normalperson@yhbt.net>.