63d2f5e962961eaba5344f8e42463485319c2670
1 git-svn(1)
2 ==========
4 NAME
5 ----
6 git-svn - Bidirectional operation between a single Subversion branch 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 single Subversion branch simply by using a
19 URL to the branch, follow branches laid out in the Subversion recommended
20 method (trunk, branches, tags directories) with the --stdlayout option, or
21 follow branches in any layout with the -T/-t/-b options (see options to
22 'init' below, and also the 'clone' command).
24 Once tracking a Subversion branch (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.
28 COMMANDS
29 --------
30 --
32 'init'::
33 Initializes an empty git repository with additional
34 metadata directories for 'git-svn'. The Subversion URL
35 may be specified as a command-line argument, or as full
36 URL arguments to -T/-t/-b. Optionally, the target
37 directory to operate on can be specified as a second
38 argument. Normally this command initializes the current
39 directory.
41 -T<trunk_subdir>;;
42 --trunk=<trunk_subdir>;;
43 -t<tags_subdir>;;
44 --tags=<tags_subdir>;;
45 -b<branches_subdir>;;
46 --branches=<branches_subdir>;;
47 -s;;
48 --stdlayout;;
49 These are optional command-line options for init. Each of
50 these flags can point to a relative repository path
51 (--tags=project/tags') or a full url
52 (--tags=https://foo.org/project/tags). The option --stdlayout is
53 a shorthand way of setting trunk,tags,branches as the relative paths,
54 which is the Subversion default. If any of the other options are given
55 as well, they take precedence.
56 --no-metadata;;
57 Set the 'noMetadata' option in the [svn-remote] config.
58 --use-svm-props;;
59 Set the 'useSvmProps' option in the [svn-remote] config.
60 --use-svnsync-props;;
61 Set the 'useSvnsyncProps' option in the [svn-remote] config.
62 --rewrite-root=<URL>;;
63 Set the 'rewriteRoot' option in the [svn-remote] config.
64 --use-log-author;;
65 When retrieving svn commits into git (as part of fetch, rebase, or
66 dcommit operations), look for the first From: or Signed-off-by: line
67 in the log message and use that as the author string.
68 --add-author-from;;
69 When committing to svn from git (as part of commit or dcommit
70 operations), if the existing log message doesn't already have a
71 From: or Signed-off-by: line, append a From: line based on the
72 git commit's author string. If you use this, then --use-log-author
73 will retrieve a valid author string for all commits.
74 --username=<USER>;;
75 For transports that SVN handles authentication for (http,
76 https, and plain svn), specify the username. For other
77 transports (eg svn+ssh://), you must include the username in
78 the URL, eg svn+ssh://foo@svn.bar.com/project
79 --prefix=<prefix>;;
80 This allows one to specify a prefix which is prepended
81 to the names of remotes if trunk/branches/tags are
82 specified. The prefix does not automatically include a
83 trailing slash, so be sure you include one in the
84 argument if that is what you want. If --branches/-b is
85 specified, the prefix must include a trailing slash.
86 Setting a prefix is useful if you wish to track multiple
87 projects that share a common repository.
89 'fetch'::
90 Fetch unfetched revisions from the Subversion remote we are
91 tracking. The name of the [svn-remote "..."] section in the
92 .git/config file may be specified as an optional command-line
93 argument.
95 --localtime;;
96 Store Git commit times in the local timezone instead of UTC. This
97 makes 'git-log' (even without --date=local) show the same times
98 that `svn log` would in the local timezone.
100 This doesn't interfere with interoperating with the Subversion
101 repository you cloned from, but if you wish for your local Git
102 repository to be able to interoperate with someone else's local Git
103 repository, either don't use this option or you should both use it in
104 the same local timezone.
106 'clone'::
107 Runs 'init' and 'fetch'. It will automatically create a
108 directory based on the basename of the URL passed to it;
109 or if a second argument is passed; it will create a directory
110 and work within that. It accepts all arguments that the
111 'init' and 'fetch' commands accept; with the exception of
112 '--fetch-all'. After a repository is cloned, the 'fetch'
113 command will be able to update revisions without affecting
114 the working tree; and the 'rebase' command will be able
115 to update the working tree with the latest changes.
117 'rebase'::
118 This fetches revisions from the SVN parent of the current HEAD
119 and rebases the current (uncommitted to SVN) work against it.
121 This works similarly to `svn update` or 'git-pull' except that
122 it preserves linear history with 'git-rebase' instead of
123 'git-merge' for ease of dcommitting with 'git-svn'.
125 This accepts all options that 'git-svn fetch' and 'git-rebase'
126 accept. However, '--fetch-all' only fetches from the current
127 [svn-remote], and not all [svn-remote] definitions.
129 Like 'git-rebase'; this requires that the working tree be clean
130 and have no uncommitted changes.
132 -l;;
133 --local;;
134 Do not fetch remotely; only run 'git-rebase' against the
135 last fetched commit from the upstream SVN.
137 'dcommit'::
138 Commit each diff from a specified head directly to the SVN
139 repository, and then rebase or reset (depending on whether or
140 not there is a diff between SVN and head). This will create
141 a revision in SVN for each commit in git.
142 It is recommended that you run 'git-svn' fetch and rebase (not
143 pull or merge) your commits against the latest changes in the
144 SVN repository.
145 An optional command-line argument may be specified as an
146 alternative to HEAD.
147 This is advantageous over 'set-tree' (below) because it produces
148 cleaner, more linear history.
149 +
150 --no-rebase;;
151 After committing, do not rebase or reset.
152 --commit-url <URL>;;
153 Commit to this SVN URL (the full path). This is intended to
154 allow existing git-svn repositories created with one transport
155 method (e.g. `svn://` or `http://` for anonymous read) to be
156 reused if a user is later given access to an alternate transport
157 method (e.g. `svn+ssh://` or `https://`) for commit.
159 Using this option for any other purpose (don't ask)
160 is very strongly discouraged.
161 --
163 'branch'::
164 Create a branch in the SVN repository.
166 -m;;
167 --message;;
168 Allows to specify the commit message.
170 -t;;
171 --tag;;
172 Create a tag by using the tags_subdir instead of the branches_subdir
173 specified during git svn init.
175 'tag'::
176 Create a tag in the SVN repository. This is a shorthand for
177 'branch -t'.
179 'log'::
180 This should make it easy to look up svn log messages when svn
181 users refer to -r/--revision numbers.
182 +
183 The following features from `svn log' are supported:
184 +
185 --
186 --revision=<n>[:<n>];;
187 is supported, non-numeric args are not:
188 HEAD, NEXT, BASE, PREV, etc ...
189 -v/--verbose;;
190 it's not completely compatible with the --verbose
191 output in svn log, but reasonably close.
192 --limit=<n>;;
193 is NOT the same as --max-count, doesn't count
194 merged/excluded commits
195 --incremental;;
196 supported
197 --
198 +
199 New features:
200 +
201 --
202 --show-commit;;
203 shows the git commit sha1, as well
204 --oneline;;
205 our version of --pretty=oneline
206 --
207 +
208 NOTE: SVN itself only stores times in UTC and nothing else. The regular svn
209 client converts the UTC time to the local time (or based on the TZ=
210 environment). This command has the same behaviour.
211 +
212 Any other arguments are passed directly to 'git-log'
214 'blame'::
215 Show what revision and author last modified each line of a file. The
216 output of this mode is format-compatible with the output of
217 `svn blame' by default. Like the SVN blame command,
218 local uncommitted changes in the working copy are ignored;
219 the version of the file in the HEAD revision is annotated. Unknown
220 arguments are passed directly to 'git-blame'.
221 +
222 --git-format;;
223 Produce output in the same format as 'git-blame', but with
224 SVN revision numbers instead of git commit hashes. In this mode,
225 changes that haven't been committed to SVN (including local
226 working-copy edits) are shown as revision 0.
228 --
229 'find-rev'::
230 When given an SVN revision number of the form 'rN', returns the
231 corresponding git commit hash (this can optionally be followed by a
232 tree-ish to specify which branch should be searched). When given a
233 tree-ish, returns the corresponding SVN revision number.
235 'set-tree'::
236 You should consider using 'dcommit' instead of this command.
237 Commit specified commit or tree objects to SVN. This relies on
238 your imported fetch data being up-to-date. This makes
239 absolutely no attempts to do patching when committing to SVN, it
240 simply overwrites files with those specified in the tree or
241 commit. All merging is assumed to have taken place
242 independently of 'git-svn' functions.
244 'create-ignore'::
245 Recursively finds the svn:ignore property on directories and
246 creates matching .gitignore files. The resulting files are staged to
247 be committed, but are not committed. Use -r/--revision to refer to a
248 specific revision.
250 'show-ignore'::
251 Recursively finds and lists the svn:ignore property on
252 directories. The output is suitable for appending to
253 the $GIT_DIR/info/exclude file.
255 'commit-diff'::
256 Commits the diff of two tree-ish arguments from the
257 command-line. This command does not rely on being inside an `git-svn
258 init`-ed repository. This command takes three arguments, (a) the
259 original tree to diff against, (b) the new tree result, (c) the
260 URL of the target Subversion repository. The final argument
261 (URL) may be omitted if you are working from a 'git-svn'-aware
262 repository (that has been `init`-ed with 'git-svn').
263 The -r<revision> option is required for this.
265 'info'::
266 Shows information about a file or directory similar to what
267 `svn info' provides. Does not currently support a -r/--revision
268 argument. Use the --url option to output only the value of the
269 'URL:' field.
271 'proplist'::
272 Lists the properties stored in the Subversion repository about a
273 given file or directory. Use -r/--revision to refer to a specific
274 Subversion revision.
276 'propget'::
277 Gets the Subversion property given as the first argument, for a
278 file. A specific revision can be specified with -r/--revision.
280 'show-externals'::
281 Shows the Subversion externals. Use -r/--revision to specify a
282 specific revision.
284 --
286 OPTIONS
287 -------
288 --
290 --shared[={false|true|umask|group|all|world|everybody}]::
291 --template=<template_directory>::
292 Only used with the 'init' command.
293 These are passed directly to 'git-init'.
295 -r <ARG>::
296 --revision <ARG>::
298 Used with the 'fetch' command.
300 This allows revision ranges for partial/cauterized history
301 to be supported. $NUMBER, $NUMBER1:$NUMBER2 (numeric ranges),
302 $NUMBER:HEAD, and BASE:$NUMBER are all supported.
304 This can allow you to make partial mirrors when running fetch;
305 but is generally not recommended because history will be skipped
306 and lost.
308 -::
309 --stdin::
311 Only used with the 'set-tree' command.
313 Read a list of commits from stdin and commit them in reverse
314 order. Only the leading sha1 is read from each line, so
315 'git-rev-list --pretty=oneline' output can be used.
317 --rmdir::
319 Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
321 Remove directories from the SVN tree if there are no files left
322 behind. SVN can version empty directories, and they are not
323 removed by default if there are no files left in them. git
324 cannot version empty directories. Enabling this flag will make
325 the commit to SVN act like git.
327 config key: svn.rmdir
329 -e::
330 --edit::
332 Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
334 Edit the commit message before committing to SVN. This is off by
335 default for objects that are commits, and forced on when committing
336 tree objects.
338 config key: svn.edit
340 -l<num>::
341 --find-copies-harder::
343 Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
345 They are both passed directly to 'git-diff-tree'; see
346 linkgit:git-diff-tree[1] for more information.
348 [verse]
349 config key: svn.l
350 config key: svn.findcopiesharder
352 -A<filename>::
353 --authors-file=<filename>::
355 Syntax is compatible with the file used by 'git-cvsimport':
357 ------------------------------------------------------------------------
358 loginname = Joe User <user@example.com>
359 ------------------------------------------------------------------------
361 If this option is specified and 'git-svn' encounters an SVN
362 committer name that does not exist in the authors-file, 'git-svn'
363 will abort operation. The user will then have to add the
364 appropriate entry. Re-running the previous 'git-svn' command
365 after the authors-file is modified should continue operation.
367 config key: svn.authorsfile
369 -q::
370 --quiet::
371 Make 'git-svn' less verbose.
373 --repack[=<n>]::
374 --repack-flags=<flags>::
376 These should help keep disk usage sane for large fetches
377 with many revisions.
379 --repack takes an optional argument for the number of revisions
380 to fetch before repacking. This defaults to repacking every
381 1000 commits fetched if no argument is specified.
383 --repack-flags are passed directly to 'git-repack'.
385 [verse]
386 config key: svn.repack
387 config key: svn.repackflags
389 -m::
390 --merge::
391 -s<strategy>::
392 --strategy=<strategy>::
394 These are only used with the 'dcommit' and 'rebase' commands.
396 Passed directly to 'git-rebase' when using 'dcommit' if a
397 'git-reset' cannot be used (see 'dcommit').
399 -n::
400 --dry-run::
402 This can be used with the 'dcommit', 'rebase', 'branch' and 'tag'
403 commands.
405 For 'dcommit', print out the series of git arguments that would show
406 which diffs would be committed to SVN.
408 For 'rebase', display the local branch associated with the upstream svn
409 repository associated with the current branch and the URL of svn
410 repository that will be fetched from.
412 For 'branch' and 'tag', display the urls that will be used for copying when
413 creating the branch or tag.
415 --
417 ADVANCED OPTIONS
418 ----------------
419 --
421 -i<GIT_SVN_ID>::
422 --id <GIT_SVN_ID>::
424 This sets GIT_SVN_ID (instead of using the environment). This
425 allows the user to override the default refname to fetch from
426 when tracking a single URL. The 'log' and 'dcommit' commands
427 no longer require this switch as an argument.
429 -R<remote name>::
430 --svn-remote <remote name>::
431 Specify the [svn-remote "<remote name>"] section to use,
432 this allows SVN multiple repositories to be tracked.
433 Default: "svn"
435 --follow-parent::
436 This is especially helpful when we're tracking a directory
437 that has been moved around within the repository, or if we
438 started tracking a branch and never tracked the trunk it was
439 descended from. This feature is enabled by default, use
440 --no-follow-parent to disable it.
442 config key: svn.followparent
444 --
445 CONFIG FILE-ONLY OPTIONS
446 ------------------------
447 --
449 svn.noMetadata::
450 svn-remote.<name>.noMetadata::
452 This gets rid of the 'git-svn-id:' lines at the end of every commit.
454 If you lose your .git/svn/git-svn/.rev_db file, 'git-svn' will not
455 be able to rebuild it and you won't be able to fetch again,
456 either. This is fine for one-shot imports.
458 The 'git-svn log' command will not work on repositories using
459 this, either. Using this conflicts with the 'useSvmProps'
460 option for (hopefully) obvious reasons.
462 svn.useSvmProps::
463 svn-remote.<name>.useSvmProps::
465 This allows 'git-svn' to re-map repository URLs and UUIDs from
466 mirrors created using SVN::Mirror (or svk) for metadata.
468 If an SVN revision has a property, "svm:headrev", it is likely
469 that the revision was created by SVN::Mirror (also used by SVK).
470 The property contains a repository UUID and a revision. We want
471 to make it look like we are mirroring the original URL, so
472 introduce a helper function that returns the original identity
473 URL and UUID, and use it when generating metadata in commit
474 messages.
476 svn.useSvnsyncProps::
477 svn-remote.<name>.useSvnsyncprops::
478 Similar to the useSvmProps option; this is for users
479 of the svnsync(1) command distributed with SVN 1.4.x and
480 later.
482 svn-remote.<name>.rewriteRoot::
483 This allows users to create repositories from alternate
484 URLs. For example, an administrator could run 'git-svn' on the
485 server locally (accessing via file://) but wish to distribute
486 the repository with a public http:// or svn:// URL in the
487 metadata so users of it will see the public URL.
489 --
491 Since the noMetadata, rewriteRoot, useSvnsyncProps and useSvmProps
492 options all affect the metadata generated and used by 'git-svn'; they
493 *must* be set in the configuration file before any history is imported
494 and these settings should never be changed once they are set.
496 Additionally, only one of these four options can be used per-svn-remote
497 section because they affect the 'git-svn-id:' metadata line.
500 BASIC EXAMPLES
501 --------------
503 Tracking and contributing to the trunk of a Subversion-managed project:
505 ------------------------------------------------------------------------
506 # Clone a repo (like git clone):
507 git svn clone http://svn.example.com/project/trunk
508 # Enter the newly cloned directory:
509 cd trunk
510 # You should be on master branch, double-check with git-branch
511 git branch
512 # Do some work and commit locally to git:
513 git commit ...
514 # Something is committed to SVN, rebase your local changes against the
515 # latest changes in SVN:
516 git svn rebase
517 # Now commit your changes (that were committed previously using git) to SVN,
518 # as well as automatically updating your working HEAD:
519 git svn dcommit
520 # Append svn:ignore settings to the default git exclude file:
521 git svn show-ignore >> .git/info/exclude
522 ------------------------------------------------------------------------
524 Tracking and contributing to an entire Subversion-managed project
525 (complete with a trunk, tags and branches):
527 ------------------------------------------------------------------------
528 # Clone a repo (like git clone):
529 git svn clone http://svn.example.com/project -T trunk -b branches -t tags
530 # View all branches and tags you have cloned:
531 git branch -r
532 # Create a new branch in SVN
533 git svn branch waldo
534 # Reset your master to trunk (or any other branch, replacing 'trunk'
535 # with the appropriate name):
536 git reset --hard remotes/trunk
537 # You may only dcommit to one branch/tag/trunk at a time. The usage
538 # of dcommit/rebase/show-ignore should be the same as above.
539 ------------------------------------------------------------------------
541 The initial 'git-svn clone' can be quite time-consuming
542 (especially for large Subversion repositories). If multiple
543 people (or one person with multiple machines) want to use
544 'git-svn' to interact with the same Subversion repository, you can
545 do the initial 'git-svn clone' to a repository on a server and
546 have each person clone that repository with 'git-clone':
548 ------------------------------------------------------------------------
549 # Do the initial import on a server
550 ssh server "cd /pub && git svn clone http://svn.example.com/project
551 # Clone locally - make sure the refs/remotes/ space matches the server
552 mkdir project
553 cd project
554 git init
555 git remote add origin server:/pub/project
556 git config --add remote.origin.fetch '+refs/remotes/*:refs/remotes/*'
557 git fetch
558 # Create a local branch from one of the branches just fetched
559 git checkout -b master FETCH_HEAD
560 # Initialize git-svn locally (be sure to use the same URL and -T/-b/-t options as were used on server)
561 git svn init http://svn.example.com/project
562 # Pull the latest changes from Subversion
563 git svn rebase
564 ------------------------------------------------------------------------
566 REBASE VS. PULL/MERGE
567 ---------------------
569 Originally, 'git-svn' recommended that the 'remotes/git-svn' branch be
570 pulled or merged from. This is because the author favored
571 `git svn set-tree B` to commit a single head rather than the
572 `git svn set-tree A..B` notation to commit multiple commits.
574 If you use `git svn set-tree A..B` to commit several diffs and you do
575 not have the latest remotes/git-svn merged into my-branch, you should
576 use `git svn rebase` to update your work branch instead of `git pull` or
577 `git merge`. `pull`/`merge' can cause non-linear history to be flattened
578 when committing into SVN, which can lead to merge commits reversing
579 previous commits in SVN.
581 DESIGN PHILOSOPHY
582 -----------------
583 Merge tracking in Subversion is lacking and doing branched development
584 with Subversion can be cumbersome as a result. While 'git-svn' can track
585 copy history (including branches and tags) for repositories adopting a
586 standard layout, it cannot yet represent merge history that happened
587 inside git back upstream to SVN users. Therefore it is advised that
588 users keep history as linear as possible inside git to ease
589 compatibility with SVN (see the CAVEATS section below).
591 CAVEATS
592 -------
594 For the sake of simplicity and interoperating with a less-capable system
595 (SVN), it is recommended that all 'git-svn' users clone, fetch and dcommit
596 directly from the SVN server, and avoid all 'git-clone'/'pull'/'merge'/'push'
597 operations between git repositories and branches. The recommended
598 method of exchanging code between git branches and users is
599 'git-format-patch' and 'git-am', or just 'dcommit'ing to the SVN repository.
601 Running 'git-merge' or 'git-pull' is NOT recommended on a branch you
602 plan to 'dcommit' from. Subversion does not represent merges in any
603 reasonable or useful fashion; so users using Subversion cannot see any
604 merges you've made. Furthermore, if you merge or pull from a git branch
605 that is a mirror of an SVN branch, 'dcommit' may commit to the wrong
606 branch.
608 'git-clone' does not clone branches under the refs/remotes/ hierarchy or
609 any 'git-svn' metadata, or config. So repositories created and managed with
610 using 'git-svn' should use 'rsync' for cloning, if cloning is to be done
611 at all.
613 Since 'dcommit' uses rebase internally, any git branches you 'git-push' to
614 before 'dcommit' on will require forcing an overwrite of the existing ref
615 on the remote repository. This is generally considered bad practice,
616 see the linkgit:git-push[1] documentation for details.
618 Do not use the --amend option of linkgit:git-commit[1] on a change you've
619 already dcommitted. It is considered bad practice to --amend commits
620 you've already pushed to a remote repository for other users, and
621 dcommit with SVN is analogous to that.
623 BUGS
624 ----
626 We ignore all SVN properties except svn:executable. Any unhandled
627 properties are logged to $GIT_DIR/svn/<refname>/unhandled.log
629 Renamed and copied directories are not detected by git and hence not
630 tracked when committing to SVN. I do not plan on adding support for
631 this as it's quite difficult and time-consuming to get working for all
632 the possible corner cases (git doesn't do it, either). Committing
633 renamed and copied files are fully supported if they're similar enough
634 for git to detect them.
636 CONFIGURATION
637 -------------
639 'git-svn' stores [svn-remote] configuration information in the
640 repository .git/config file. It is similar the core git
641 [remote] sections except 'fetch' keys do not accept glob
642 arguments; but they are instead handled by the 'branches'
643 and 'tags' keys. Since some SVN repositories are oddly
644 configured with multiple projects glob expansions such those
645 listed below are allowed:
647 ------------------------------------------------------------------------
648 [svn-remote "project-a"]
649 url = http://server.org/svn
650 branches = branches/*/project-a:refs/remotes/project-a/branches/*
651 tags = tags/*/project-a:refs/remotes/project-a/tags/*
652 trunk = trunk/project-a:refs/remotes/project-a/trunk
653 ------------------------------------------------------------------------
655 Keep in mind that the '*' (asterisk) wildcard of the local ref
656 (right of the ':') *must* be the farthest right path component;
657 however the remote wildcard may be anywhere as long as it's own
658 independent path component (surrounded by '/' or EOL). This
659 type of configuration is not automatically created by 'init' and
660 should be manually entered with a text-editor or using 'git-config'.
662 SEE ALSO
663 --------
664 linkgit:git-rebase[1]
666 Author
667 ------
668 Written by Eric Wong <normalperson@yhbt.net>.
670 Documentation
671 -------------
672 Written by Eric Wong <normalperson@yhbt.net>.