Code

Merge branch 'maint-1.6.1' into maint
[git.git] / Documentation / git-svn.txt
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 --ignore-paths=<regex>;;
107         This allows one to specify Perl regular expression that will
108         cause skipping of all matching paths from checkout from SVN.
109         Examples:
111         --ignore-paths="^doc" - skip "doc*" directory for every fetch.
113         --ignore-paths="^[^/]+/(?:branches|tags)" - skip "branches"
114             and "tags" of first level directories.
116         Regular expression is not persistent, you should specify
117         it every time when fetching.
119 'clone'::
120         Runs 'init' and 'fetch'.  It will automatically create a
121         directory based on the basename of the URL passed to it;
122         or if a second argument is passed; it will create a directory
123         and work within that.  It accepts all arguments that the
124         'init' and 'fetch' commands accept; with the exception of
125         '--fetch-all'.   After a repository is cloned, the 'fetch'
126         command will be able to update revisions without affecting
127         the working tree; and the 'rebase' command will be able
128         to update the working tree with the latest changes.
130 'rebase'::
131         This fetches revisions from the SVN parent of the current HEAD
132         and rebases the current (uncommitted to SVN) work against it.
134 This works similarly to `svn update` or 'git-pull' except that
135 it preserves linear history with 'git-rebase' instead of
136 'git-merge' for ease of dcommitting with 'git-svn'.
138 This accepts all options that 'git-svn fetch' and 'git-rebase'
139 accept.  However, '--fetch-all' only fetches from the current
140 [svn-remote], and not all [svn-remote] definitions.
142 Like 'git-rebase'; this requires that the working tree be clean
143 and have no uncommitted changes.
145 -l;;
146 --local;;
147         Do not fetch remotely; only run 'git-rebase' against the
148         last fetched commit from the upstream SVN.
150 'dcommit'::
151         Commit each diff from a specified head directly to the SVN
152         repository, and then rebase or reset (depending on whether or
153         not there is a diff between SVN and head).  This will create
154         a revision in SVN for each commit in git.
155         It is recommended that you run 'git-svn' fetch and rebase (not
156         pull or merge) your commits against the latest changes in the
157         SVN repository.
158         An optional command-line argument may be specified as an
159         alternative to HEAD.
160         This is advantageous over 'set-tree' (below) because it produces
161         cleaner, more linear history.
163 --no-rebase;;
164         After committing, do not rebase or reset.
165 --commit-url <URL>;;
166         Commit to this SVN URL (the full path).  This is intended to
167         allow existing git-svn repositories created with one transport
168         method (e.g. `svn://` or `http://` for anonymous read) to be
169         reused if a user is later given access to an alternate transport
170         method (e.g. `svn+ssh://` or `https://`) for commit.
172 config key: svn-remote.<name>.commiturl
174 config key: svn.commiturl (overwrites all svn-remote.<name>.commiturl options)
176         Using this option for any other purpose (don't ask)
177         is very strongly discouraged.
178 --
180 'branch'::
181         Create a branch in the SVN repository.
183 -m;;
184 --message;;
185         Allows to specify the commit message.
187 -t;;
188 --tag;;
189         Create a tag by using the tags_subdir instead of the branches_subdir
190         specified during git svn init.
192 'tag'::
193         Create a tag in the SVN repository. This is a shorthand for
194         'branch -t'.
196 'log'::
197         This should make it easy to look up svn log messages when svn
198         users refer to -r/--revision numbers.
200 The following features from `svn log' are supported:
202 --
203 --revision=<n>[:<n>];;
204         is supported, non-numeric args are not:
205         HEAD, NEXT, BASE, PREV, etc ...
206 -v/--verbose;;
207         it's not completely compatible with the --verbose
208         output in svn log, but reasonably close.
209 --limit=<n>;;
210         is NOT the same as --max-count, doesn't count
211         merged/excluded commits
212 --incremental;;
213         supported
214 --
216 New features:
218 --
219 --show-commit;;
220         shows the git commit sha1, as well
221 --oneline;;
222         our version of --pretty=oneline
223 --
225 NOTE: SVN itself only stores times in UTC and nothing else. The regular svn
226 client converts the UTC time to the local time (or based on the TZ=
227 environment). This command has the same behaviour.
229 Any other arguments are passed directly to 'git-log'
231 'blame'::
232        Show what revision and author last modified each line of a file. The
233        output of this mode is format-compatible with the output of
234        `svn blame' by default. Like the SVN blame command,
235        local uncommitted changes in the working copy are ignored;
236        the version of the file in the HEAD revision is annotated. Unknown
237        arguments are passed directly to 'git-blame'.
239 --git-format;;
240         Produce output in the same format as 'git-blame', but with
241         SVN revision numbers instead of git commit hashes. In this mode,
242         changes that haven't been committed to SVN (including local
243         working-copy edits) are shown as revision 0.
245 --
246 'find-rev'::
247         When given an SVN revision number of the form 'rN', returns the
248         corresponding git commit hash (this can optionally be followed by a
249         tree-ish to specify which branch should be searched).  When given a
250         tree-ish, returns the corresponding SVN revision number.
252 'set-tree'::
253         You should consider using 'dcommit' instead of this command.
254         Commit specified commit or tree objects to SVN.  This relies on
255         your imported fetch data being up-to-date.  This makes
256         absolutely no attempts to do patching when committing to SVN, it
257         simply overwrites files with those specified in the tree or
258         commit.  All merging is assumed to have taken place
259         independently of 'git-svn' functions.
261 'create-ignore'::
262         Recursively finds the svn:ignore property on directories and
263         creates matching .gitignore files. The resulting files are staged to
264         be committed, but are not committed. Use -r/--revision to refer to a
265         specific revision.
267 'show-ignore'::
268         Recursively finds and lists the svn:ignore property on
269         directories.  The output is suitable for appending to
270         the $GIT_DIR/info/exclude file.
272 'commit-diff'::
273         Commits the diff of two tree-ish arguments from the
274         command-line.  This command does not rely on being inside an `git-svn
275         init`-ed repository.  This command takes three arguments, (a) the
276         original tree to diff against, (b) the new tree result, (c) the
277         URL of the target Subversion repository.  The final argument
278         (URL) may be omitted if you are working from a 'git-svn'-aware
279         repository (that has been `init`-ed with 'git-svn').
280         The -r<revision> option is required for this.
282 'info'::
283         Shows information about a file or directory similar to what
284         `svn info' provides.  Does not currently support a -r/--revision
285         argument.  Use the --url option to output only the value of the
286         'URL:' field.
288 'proplist'::
289         Lists the properties stored in the Subversion repository about a
290         given file or directory.  Use -r/--revision to refer to a specific
291         Subversion revision.
293 'propget'::
294         Gets the Subversion property given as the first argument, for a
295         file.  A specific revision can be specified with -r/--revision.
297 'show-externals'::
298         Shows the Subversion externals.  Use -r/--revision to specify a
299         specific revision.
301 --
303 OPTIONS
304 -------
305 --
307 --shared[={false|true|umask|group|all|world|everybody}]::
308 --template=<template_directory>::
309         Only used with the 'init' command.
310         These are passed directly to 'git-init'.
312 -r <ARG>::
313 --revision <ARG>::
315 Used with the 'fetch' command.
317 This allows revision ranges for partial/cauterized history
318 to be supported.  $NUMBER, $NUMBER1:$NUMBER2 (numeric ranges),
319 $NUMBER:HEAD, and BASE:$NUMBER are all supported.
321 This can allow you to make partial mirrors when running fetch;
322 but is generally not recommended because history will be skipped
323 and lost.
325 -::
326 --stdin::
328 Only used with the 'set-tree' command.
330 Read a list of commits from stdin and commit them in reverse
331 order.  Only the leading sha1 is read from each line, so
332 'git-rev-list --pretty=oneline' output can be used.
334 --rmdir::
336 Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
338 Remove directories from the SVN tree if there are no files left
339 behind.  SVN can version empty directories, and they are not
340 removed by default if there are no files left in them.  git
341 cannot version empty directories.  Enabling this flag will make
342 the commit to SVN act like git.
344 config key: svn.rmdir
346 -e::
347 --edit::
349 Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
351 Edit the commit message before committing to SVN.  This is off by
352 default for objects that are commits, and forced on when committing
353 tree objects.
355 config key: svn.edit
357 -l<num>::
358 --find-copies-harder::
360 Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
362 They are both passed directly to 'git-diff-tree'; see
363 linkgit:git-diff-tree[1] for more information.
365 [verse]
366 config key: svn.l
367 config key: svn.findcopiesharder
369 -A<filename>::
370 --authors-file=<filename>::
372 Syntax is compatible with the file used by 'git-cvsimport':
374 ------------------------------------------------------------------------
375         loginname = Joe User <user@example.com>
376 ------------------------------------------------------------------------
378 If this option is specified and 'git-svn' encounters an SVN
379 committer name that does not exist in the authors-file, 'git-svn'
380 will abort operation. The user will then have to add the
381 appropriate entry.  Re-running the previous 'git-svn' command
382 after the authors-file is modified should continue operation.
384 config key: svn.authorsfile
386 -q::
387 --quiet::
388         Make 'git-svn' less verbose.
390 --repack[=<n>]::
391 --repack-flags=<flags>::
393 These should help keep disk usage sane for large fetches
394 with many revisions.
396 --repack takes an optional argument for the number of revisions
397 to fetch before repacking.  This defaults to repacking every
398 1000 commits fetched if no argument is specified.
400 --repack-flags are passed directly to 'git-repack'.
402 [verse]
403 config key: svn.repack
404 config key: svn.repackflags
406 -m::
407 --merge::
408 -s<strategy>::
409 --strategy=<strategy>::
411 These are only used with the 'dcommit' and 'rebase' commands.
413 Passed directly to 'git-rebase' when using 'dcommit' if a
414 'git-reset' cannot be used (see 'dcommit').
416 -n::
417 --dry-run::
419 This can be used with the 'dcommit', 'rebase', 'branch' and 'tag'
420 commands.
422 For 'dcommit', print out the series of git arguments that would show
423 which diffs would be committed to SVN.
425 For 'rebase', display the local branch associated with the upstream svn
426 repository associated with the current branch and the URL of svn
427 repository that will be fetched from.
429 For 'branch' and 'tag', display the urls that will be used for copying when
430 creating the branch or tag.
432 --
434 ADVANCED OPTIONS
435 ----------------
436 --
438 -i<GIT_SVN_ID>::
439 --id <GIT_SVN_ID>::
441 This sets GIT_SVN_ID (instead of using the environment).  This
442 allows the user to override the default refname to fetch from
443 when tracking a single URL.  The 'log' and 'dcommit' commands
444 no longer require this switch as an argument.
446 -R<remote name>::
447 --svn-remote <remote name>::
448         Specify the [svn-remote "<remote name>"] section to use,
449         this allows SVN multiple repositories to be tracked.
450         Default: "svn"
452 --follow-parent::
453         This is especially helpful when we're tracking a directory
454         that has been moved around within the repository, or if we
455         started tracking a branch and never tracked the trunk it was
456         descended from. This feature is enabled by default, use
457         --no-follow-parent to disable it.
459 config key: svn.followparent
461 --
462 CONFIG FILE-ONLY OPTIONS
463 ------------------------
464 --
466 svn.noMetadata::
467 svn-remote.<name>.noMetadata::
469 This gets rid of the 'git-svn-id:' lines at the end of every commit.
471 If you lose your .git/svn/git-svn/.rev_db file, 'git-svn' will not
472 be able to rebuild it and you won't be able to fetch again,
473 either.  This is fine for one-shot imports.
475 The 'git-svn log' command will not work on repositories using
476 this, either.  Using this conflicts with the 'useSvmProps'
477 option for (hopefully) obvious reasons.
479 svn.useSvmProps::
480 svn-remote.<name>.useSvmProps::
482 This allows 'git-svn' to re-map repository URLs and UUIDs from
483 mirrors created using SVN::Mirror (or svk) for metadata.
485 If an SVN revision has a property, "svm:headrev", it is likely
486 that the revision was created by SVN::Mirror (also used by SVK).
487 The property contains a repository UUID and a revision.  We want
488 to make it look like we are mirroring the original URL, so
489 introduce a helper function that returns the original identity
490 URL and UUID, and use it when generating metadata in commit
491 messages.
493 svn.useSvnsyncProps::
494 svn-remote.<name>.useSvnsyncprops::
495         Similar to the useSvmProps option; this is for users
496         of the svnsync(1) command distributed with SVN 1.4.x and
497         later.
499 svn-remote.<name>.rewriteRoot::
500         This allows users to create repositories from alternate
501         URLs.  For example, an administrator could run 'git-svn' on the
502         server locally (accessing via file://) but wish to distribute
503         the repository with a public http:// or svn:// URL in the
504         metadata so users of it will see the public URL.
506 svn.brokenSymlinkWorkaround::
507 This disables potentially expensive checks to workaround broken symlinks
508 checked into SVN by broken clients.  Set this option to "false" if you
509 track a SVN repository with many empty blobs that are not symlinks.
510 This option may be changed while "git-svn" is running and take effect on
511 the next revision fetched.  If unset, git-svn assumes this option to be
512 "true".
514 --
516 Since the noMetadata, rewriteRoot, useSvnsyncProps and useSvmProps
517 options all affect the metadata generated and used by 'git-svn'; they
518 *must* be set in the configuration file before any history is imported
519 and these settings should never be changed once they are set.
521 Additionally, only one of these four options can be used per-svn-remote
522 section because they affect the 'git-svn-id:' metadata line.
525 BASIC EXAMPLES
526 --------------
528 Tracking and contributing to the trunk of a Subversion-managed project:
530 ------------------------------------------------------------------------
531 # Clone a repo (like git clone):
532         git svn clone http://svn.example.com/project/trunk
533 # Enter the newly cloned directory:
534         cd trunk
535 # You should be on master branch, double-check with git-branch
536         git branch
537 # Do some work and commit locally to git:
538         git commit ...
539 # Something is committed to SVN, rebase your local changes against the
540 # latest changes in SVN:
541         git svn rebase
542 # Now commit your changes (that were committed previously using git) to SVN,
543 # as well as automatically updating your working HEAD:
544         git svn dcommit
545 # Append svn:ignore settings to the default git exclude file:
546         git svn show-ignore >> .git/info/exclude
547 ------------------------------------------------------------------------
549 Tracking and contributing to an entire Subversion-managed project
550 (complete with a trunk, tags and branches):
552 ------------------------------------------------------------------------
553 # Clone a repo (like git clone):
554         git svn clone http://svn.example.com/project -T trunk -b branches -t tags
555 # View all branches and tags you have cloned:
556         git branch -r
557 # Create a new branch in SVN
558     git svn branch waldo
559 # Reset your master to trunk (or any other branch, replacing 'trunk'
560 # with the appropriate name):
561         git reset --hard remotes/trunk
562 # You may only dcommit to one branch/tag/trunk at a time.  The usage
563 # of dcommit/rebase/show-ignore should be the same as above.
564 ------------------------------------------------------------------------
566 The initial 'git-svn clone' can be quite time-consuming
567 (especially for large Subversion repositories). If multiple
568 people (or one person with multiple machines) want to use
569 'git-svn' to interact with the same Subversion repository, you can
570 do the initial 'git-svn clone' to a repository on a server and
571 have each person clone that repository with 'git-clone':
573 ------------------------------------------------------------------------
574 # Do the initial import on a server
575         ssh server "cd /pub && git svn clone http://svn.example.com/project
576 # Clone locally - make sure the refs/remotes/ space matches the server
577         mkdir project
578         cd project
579         git init
580         git remote add origin server:/pub/project
581         git config --add remote.origin.fetch '+refs/remotes/*:refs/remotes/*'
582         git fetch
583 # Create a local branch from one of the branches just fetched
584         git checkout -b master FETCH_HEAD
585 # Initialize git-svn locally (be sure to use the same URL and -T/-b/-t options as were used on server)
586         git svn init http://svn.example.com/project
587 # Pull the latest changes from Subversion
588         git svn rebase
589 ------------------------------------------------------------------------
591 REBASE VS. PULL/MERGE
592 ---------------------
594 Originally, 'git-svn' recommended that the 'remotes/git-svn' branch be
595 pulled or merged from.  This is because the author favored
596 `git svn set-tree B` to commit a single head rather than the
597 `git svn set-tree A..B` notation to commit multiple commits.
599 If you use `git svn set-tree A..B` to commit several diffs and you do
600 not have the latest remotes/git-svn merged into my-branch, you should
601 use `git svn rebase` to update your work branch instead of `git pull` or
602 `git merge`.  `pull`/`merge' can cause non-linear history to be flattened
603 when committing into SVN, which can lead to merge commits reversing
604 previous commits in SVN.
606 DESIGN PHILOSOPHY
607 -----------------
608 Merge tracking in Subversion is lacking and doing branched development
609 with Subversion can be cumbersome as a result.  While 'git-svn' can track
610 copy history (including branches and tags) for repositories adopting a
611 standard layout, it cannot yet represent merge history that happened
612 inside git back upstream to SVN users.  Therefore it is advised that
613 users keep history as linear as possible inside git to ease
614 compatibility with SVN (see the CAVEATS section below).
616 CAVEATS
617 -------
619 For the sake of simplicity and interoperating with a less-capable system
620 (SVN), it is recommended that all 'git-svn' users clone, fetch and dcommit
621 directly from the SVN server, and avoid all 'git-clone'/'pull'/'merge'/'push'
622 operations between git repositories and branches.  The recommended
623 method of exchanging code between git branches and users is
624 'git-format-patch' and 'git-am', or just 'dcommit'ing to the SVN repository.
626 Running 'git-merge' or 'git-pull' is NOT recommended on a branch you
627 plan to 'dcommit' from.  Subversion does not represent merges in any
628 reasonable or useful fashion; so users using Subversion cannot see any
629 merges you've made.  Furthermore, if you merge or pull from a git branch
630 that is a mirror of an SVN branch, 'dcommit' may commit to the wrong
631 branch.
633 'git-clone' does not clone branches under the refs/remotes/ hierarchy or
634 any 'git-svn' metadata, or config.  So repositories created and managed with
635 using 'git-svn' should use 'rsync' for cloning, if cloning is to be done
636 at all.
638 Since 'dcommit' uses rebase internally, any git branches you 'git-push' to
639 before 'dcommit' on will require forcing an overwrite of the existing ref
640 on the remote repository.  This is generally considered bad practice,
641 see the linkgit:git-push[1] documentation for details.
643 Do not use the --amend option of linkgit:git-commit[1] on a change you've
644 already dcommitted.  It is considered bad practice to --amend commits
645 you've already pushed to a remote repository for other users, and
646 dcommit with SVN is analogous to that.
648 BUGS
649 ----
651 We ignore all SVN properties except svn:executable.  Any unhandled
652 properties are logged to $GIT_DIR/svn/<refname>/unhandled.log
654 Renamed and copied directories are not detected by git and hence not
655 tracked when committing to SVN.  I do not plan on adding support for
656 this as it's quite difficult and time-consuming to get working for all
657 the possible corner cases (git doesn't do it, either).  Committing
658 renamed and copied files are fully supported if they're similar enough
659 for git to detect them.
661 CONFIGURATION
662 -------------
664 'git-svn' stores [svn-remote] configuration information in the
665 repository .git/config file.  It is similar the core git
666 [remote] sections except 'fetch' keys do not accept glob
667 arguments; but they are instead handled by the 'branches'
668 and 'tags' keys.  Since some SVN repositories are oddly
669 configured with multiple projects glob expansions such those
670 listed below are allowed:
672 ------------------------------------------------------------------------
673 [svn-remote "project-a"]
674         url = http://server.org/svn
675         branches = branches/*/project-a:refs/remotes/project-a/branches/*
676         tags = tags/*/project-a:refs/remotes/project-a/tags/*
677         trunk = trunk/project-a:refs/remotes/project-a/trunk
678 ------------------------------------------------------------------------
680 Keep in mind that the '*' (asterisk) wildcard of the local ref
681 (right of the ':') *must* be the farthest right path component;
682 however the remote wildcard may be anywhere as long as it's own
683 independent path component (surrounded by '/' or EOL).   This
684 type of configuration is not automatically created by 'init' and
685 should be manually entered with a text-editor or using 'git-config'.
687 SEE ALSO
688 --------
689 linkgit:git-rebase[1]
691 Author
692 ------
693 Written by Eric Wong <normalperson@yhbt.net>.
695 Documentation
696 -------------
697 Written by Eric Wong <normalperson@yhbt.net>.