Code

git-svn: add documentation for --add-author-from option.
[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 is not to be confused with linkgit:git-svnimport[1], which is
16 read-only.
18 git-svn was originally designed for an individual developer who wants a
19 bidirectional flow of changesets between a single branch in Subversion
20 and an arbitrary number of branches in git.  Since its inception,
21 git-svn has gained the ability to track multiple branches in a manner
22 similar to git-svnimport.
24 git-svn is especially useful when it comes to tracking repositories
25 not organized in the way Subversion developers recommend (trunk,
26 branches, tags directories).
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 'clone'::
96         Runs 'init' and 'fetch'.  It will automatically create a
97         directory based on the basename of the URL passed to it;
98         or if a second argument is passed; it will create a directory
99         and work within that.  It accepts all arguments that the
100         'init' and 'fetch' commands accept; with the exception of
101         '--fetch-all'.   After a repository is cloned, the 'fetch'
102         command will be able to update revisions without affecting
103         the working tree; and the 'rebase' command will be able
104         to update the working tree with the latest changes.
106 'rebase'::
107         This fetches revisions from the SVN parent of the current HEAD
108         and rebases the current (uncommitted to SVN) work against it.
110 This works similarly to 'svn update' or 'git-pull' except that
111 it preserves linear history with 'git-rebase' instead of
112 'git-merge' for ease of dcommiting with git-svn.
114 This accepts all options that 'git-svn fetch' and 'git-rebase'
115 accepts.  However '--fetch-all' only fetches from the current
116 [svn-remote], and not all [svn-remote] definitions.
118 Like 'git-rebase'; this requires that the working tree be clean
119 and have no uncommitted changes.
121 -l;;
122 --local;;
123         Do not fetch remotely; only run 'git-rebase' against the
124         last fetched commit from the upstream SVN.
126 'dcommit'::
127         Commit each diff from a specified head directly to the SVN
128         repository, and then rebase or reset (depending on whether or
129         not there is a diff between SVN and head).  This will create
130         a revision in SVN for each commit in git.
131         It is recommended that you run git-svn fetch and rebase (not
132         pull or merge) your commits against the latest changes in the
133         SVN repository.
134         An optional command-line argument may be specified as an
135         alternative to HEAD.
136         This is advantageous over 'set-tree' (below) because it produces
137         cleaner, more linear history.
139 --no-rebase;;
140         After committing, do not rebase or reset.
141 --
143 'log'::
144         This should make it easy to look up svn log messages when svn
145         users refer to -r/--revision numbers.
147 The following features from `svn log' are supported:
149 --
150 --revision=<n>[:<n>];;
151         is supported, non-numeric args are not:
152         HEAD, NEXT, BASE, PREV, etc ...
153 -v/--verbose;;
154         it's not completely compatible with the --verbose
155         output in svn log, but reasonably close.
156 --limit=<n>;;
157         is NOT the same as --max-count, doesn't count
158         merged/excluded commits
159 --incremental;;
160         supported
161 --
163 New features:
165 --
166 --show-commit;;
167         shows the git commit sha1, as well
168 --oneline;;
169         our version of --pretty=oneline
170 --
172 NOTE: SVN itself only stores times in UTC and nothing else. The regular svn
173 client converts the UTC time to the local time (or based on the TZ=
174 environment). This command has the same behaviour.
176 Any other arguments are passed directly to `git log'
178 'blame'::
179        Show what revision and author last modified each line of a file. This is
180        identical to `git blame', but SVN revision numbers are shown instead of git
181        commit hashes.
183 All arguments are passed directly to `git blame'.
185 --
186 'find-rev'::
187         When given an SVN revision number of the form 'rN', returns the
188         corresponding git commit hash (this can optionally be followed by a
189         tree-ish to specify which branch should be searched).  When given a
190         tree-ish, returns the corresponding SVN revision number.
192 'set-tree'::
193         You should consider using 'dcommit' instead of this command.
194         Commit specified commit or tree objects to SVN.  This relies on
195         your imported fetch data being up-to-date.  This makes
196         absolutely no attempts to do patching when committing to SVN, it
197         simply overwrites files with those specified in the tree or
198         commit.  All merging is assumed to have taken place
199         independently of git-svn functions.
201 'show-ignore'::
202         Recursively finds and lists the svn:ignore property on
203         directories.  The output is suitable for appending to
204         the $GIT_DIR/info/exclude file.
206 'commit-diff'::
207         Commits the diff of two tree-ish arguments from the
208         command-line.  This command is intended for interoperability with
209         git-svnimport and does not rely on being inside an git-svn
210         init-ed repository.  This command takes three arguments, (a) the
211         original tree to diff against, (b) the new tree result, (c) the
212         URL of the target Subversion repository.  The final argument
213         (URL) may be omitted if you are working from a git-svn-aware
214         repository (that has been init-ed with git-svn).
215         The -r<revision> option is required for this.
217 'info'::
218         Shows information about a file or directory similar to what
219         `svn info' provides.  Does not currently support a -r/--revision
220         argument.  Use the --url option to output only the value of the
221         'URL:' field.
223 --
225 OPTIONS
226 -------
227 --
229 --shared[={false|true|umask|group|all|world|everybody}]::
230 --template=<template_directory>::
231         Only used with the 'init' command.
232         These are passed directly to linkgit:git-init[1].
234 -r <ARG>::
235 --revision <ARG>::
237 Used with the 'fetch' command.
239 This allows revision ranges for partial/cauterized history
240 to be supported.  $NUMBER, $NUMBER1:$NUMBER2 (numeric ranges),
241 $NUMBER:HEAD, and BASE:$NUMBER are all supported.
243 This can allow you to make partial mirrors when running fetch;
244 but is generally not recommended because history will be skipped
245 and lost.
247 -::
248 --stdin::
250 Only used with the 'set-tree' command.
252 Read a list of commits from stdin and commit them in reverse
253 order.  Only the leading sha1 is read from each line, so
254 git-rev-list --pretty=oneline output can be used.
256 --rmdir::
258 Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
260 Remove directories from the SVN tree if there are no files left
261 behind.  SVN can version empty directories, and they are not
262 removed by default if there are no files left in them.  git
263 cannot version empty directories.  Enabling this flag will make
264 the commit to SVN act like git.
266 config key: svn.rmdir
268 -e::
269 --edit::
271 Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
273 Edit the commit message before committing to SVN.  This is off by
274 default for objects that are commits, and forced on when committing
275 tree objects.
277 config key: svn.edit
279 -l<num>::
280 --find-copies-harder::
282 Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
284 They are both passed directly to git-diff-tree see
285 linkgit:git-diff-tree[1] for more information.
287 [verse]
288 config key: svn.l
289 config key: svn.findcopiesharder
291 -A<filename>::
292 --authors-file=<filename>::
294 Syntax is compatible with the files used by git-svnimport and
295 git-cvsimport:
297 ------------------------------------------------------------------------
298         loginname = Joe User <user@example.com>
299 ------------------------------------------------------------------------
301 If this option is specified and git-svn encounters an SVN
302 committer name that does not exist in the authors-file, git-svn
303 will abort operation. The user will then have to add the
304 appropriate entry.  Re-running the previous git-svn command
305 after the authors-file is modified should continue operation.
307 config key: svn.authorsfile
309 -q::
310 --quiet::
311         Make git-svn less verbose.
313 --repack[=<n>]::
314 --repack-flags=<flags>::
316 These should help keep disk usage sane for large fetches
317 with many revisions.
319 --repack takes an optional argument for the number of revisions
320 to fetch before repacking.  This defaults to repacking every
321 1000 commits fetched if no argument is specified.
323 --repack-flags are passed directly to linkgit:git-repack[1].
325 [verse]
326 config key: svn.repack
327 config key: svn.repackflags
329 -m::
330 --merge::
331 -s<strategy>::
332 --strategy=<strategy>::
334 These are only used with the 'dcommit' and 'rebase' commands.
336 Passed directly to git-rebase when using 'dcommit' if a
337 'git-reset' cannot be used (see dcommit).
339 -n::
340 --dry-run::
342 This is only used with the 'dcommit' command.
344 Print out the series of git arguments that would show
345 which diffs would be committed to SVN.
347 --
349 ADVANCED OPTIONS
350 ----------------
351 --
353 -i<GIT_SVN_ID>::
354 --id <GIT_SVN_ID>::
356 This sets GIT_SVN_ID (instead of using the environment).  This
357 allows the user to override the default refname to fetch from
358 when tracking a single URL.  The 'log' and 'dcommit' commands
359 no longer require this switch as an argument.
361 -R<remote name>::
362 --svn-remote <remote name>::
363         Specify the [svn-remote "<remote name>"] section to use,
364         this allows SVN multiple repositories to be tracked.
365         Default: "svn"
367 --follow-parent::
368         This is especially helpful when we're tracking a directory
369         that has been moved around within the repository, or if we
370         started tracking a branch and never tracked the trunk it was
371         descended from. This feature is enabled by default, use
372         --no-follow-parent to disable it.
374 config key: svn.followparent
376 --
377 CONFIG FILE-ONLY OPTIONS
378 ------------------------
379 --
381 svn.noMetadata::
382 svn-remote.<name>.noMetadata::
384 This gets rid of the git-svn-id: lines at the end of every commit.
386 If you lose your .git/svn/git-svn/.rev_db file, git-svn will not
387 be able to rebuild it and you won't be able to fetch again,
388 either.  This is fine for one-shot imports.
390 The 'git-svn log' command will not work on repositories using
391 this, either.  Using this conflicts with the 'useSvmProps'
392 option for (hopefully) obvious reasons.
394 svn.useSvmProps::
395 svn-remote.<name>.useSvmProps::
397 This allows git-svn to re-map repository URLs and UUIDs from
398 mirrors created using SVN::Mirror (or svk) for metadata.
400 If an SVN revision has a property, "svm:headrev", it is likely
401 that the revision was created by SVN::Mirror (also used by SVK).
402 The property contains a repository UUID and a revision.  We want
403 to make it look like we are mirroring the original URL, so
404 introduce a helper function that returns the original identity
405 URL and UUID, and use it when generating metadata in commit
406 messages.
408 svn.useSvnsyncProps::
409 svn-remote.<name>.useSvnsyncprops::
410         Similar to the useSvmProps option; this is for users
411         of the svnsync(1) command distributed with SVN 1.4.x and
412         later.
414 svn-remote.<name>.rewriteRoot::
415         This allows users to create repositories from alternate
416         URLs.  For example, an administrator could run git-svn on the
417         server locally (accessing via file://) but wish to distribute
418         the repository with a public http:// or svn:// URL in the
419         metadata so users of it will see the public URL.
421 Since the noMetadata, rewriteRoot, useSvnsyncProps and useSvmProps
422 options all affect the metadata generated and used by git-svn; they
423 *must* be set in the configuration file before any history is imported
424 and these settings should never be changed once they are set.
426 Additionally, only one of these four options can be used per-svn-remote
427 section because they affect the 'git-svn-id:' metadata line.
429 --
431 BASIC EXAMPLES
432 --------------
434 Tracking and contributing to the trunk of a Subversion-managed project:
436 ------------------------------------------------------------------------
437 # Clone a repo (like git clone):
438         git-svn clone http://svn.foo.org/project/trunk
439 # Enter the newly cloned directory:
440         cd trunk
441 # You should be on master branch, double-check with git-branch
442         git branch
443 # Do some work and commit locally to git:
444         git commit ...
445 # Something is committed to SVN, rebase your local changes against the
446 # latest changes in SVN:
447         git-svn rebase
448 # Now commit your changes (that were committed previously using git) to SVN,
449 # as well as automatically updating your working HEAD:
450         git-svn dcommit
451 # Append svn:ignore settings to the default git exclude file:
452         git-svn show-ignore >> .git/info/exclude
453 ------------------------------------------------------------------------
455 Tracking and contributing to an entire Subversion-managed project
456 (complete with a trunk, tags and branches):
458 ------------------------------------------------------------------------
459 # Clone a repo (like git clone):
460         git-svn clone http://svn.foo.org/project -T trunk -b branches -t tags
461 # View all branches and tags you have cloned:
462         git branch -r
463 # Reset your master to trunk (or any other branch, replacing 'trunk'
464 # with the appropriate name):
465         git reset --hard remotes/trunk
466 # You may only dcommit to one branch/tag/trunk at a time.  The usage
467 # of dcommit/rebase/show-ignore should be the same as above.
468 ------------------------------------------------------------------------
470 The initial 'git-svn clone' can be quite time-consuming
471 (especially for large Subversion repositories). If multiple
472 people (or one person with multiple machines) want to use
473 git-svn to interact with the same Subversion repository, you can
474 do the initial 'git-svn clone' to a repository on a server and
475 have each person clone that repository with 'git clone':
477 ------------------------------------------------------------------------
478 # Do the initial import on a server
479         ssh server "cd /pub && git-svn clone http://svn.foo.org/project
480 # Clone locally - make sure the refs/remotes/ space matches the server
481         mkdir project
482         cd project
483         git-init
484         git remote add origin server:/pub/project
485         git config --add remote.origin.fetch=+refs/remotes/*:refs/remotes/*
486         git fetch
487 # Initialize git-svn locally (be sure to use the same URL and -T/-b/-t options as were used on server)
488         git-svn init http://svn.foo.org/project
489 # Pull the latest changes from Subversion
490         git-svn rebase
491 ------------------------------------------------------------------------
493 REBASE VS. PULL/MERGE
494 ---------------------
496 Originally, git-svn recommended that the remotes/git-svn branch be
497 pulled or merged from.  This is because the author favored
498 'git-svn set-tree B' to commit a single head rather than the
499 'git-svn set-tree A..B' notation to commit multiple commits.
501 If you use 'git-svn set-tree A..B' to commit several diffs and you do
502 not have the latest remotes/git-svn merged into my-branch, you should
503 use 'git-svn rebase' to update your work branch instead of 'git pull' or
504 'git merge'.  'pull/merge' can cause non-linear history to be flattened
505 when committing into SVN, which can lead to merge commits reversing
506 previous commits in SVN.
508 DESIGN PHILOSOPHY
509 -----------------
510 Merge tracking in Subversion is lacking and doing branched development
511 with Subversion can be cumbersome as a result.  While git-svn can track
512 copy history (including branches and tags) for repositories adopting a
513 standard layout, it cannot yet represent merge history that happened
514 inside git back upstream to SVN users.  Therefore it is advised that
515 users keep history as linear as possible inside git to ease
516 compatibility with SVN (see the CAVEATS section below).
518 CAVEATS
519 -------
521 For the sake of simplicity and interoperating with a less-capable system
522 (SVN), it is recommended that all git-svn users clone, fetch and dcommit
523 directly from the SVN server, and avoid all git-clone/pull/merge/push
524 operations between git repositories and branches.  The recommended
525 method of exchanging code between git branches and users is
526 git-format-patch and git-am, or just dcommiting to the SVN repository.
528 Running 'git-merge' or 'git-pull' is NOT recommended on a branch you
529 plan to dcommit from.  Subversion does not represent merges in any
530 reasonable or useful fashion; so users using Subversion cannot see any
531 merges you've made.  Furthermore, if you merge or pull from a git branch
532 that is a mirror of an SVN branch, dcommit may commit to the wrong
533 branch.
535 'git-clone' does not clone branches under the refs/remotes/ hierarchy or
536 any git-svn metadata, or config.  So repositories created and managed with
537 using git-svn should use rsync(1) for cloning, if cloning is to be done
538 at all.
540 Since 'dcommit' uses rebase internally, any git branches you git-push to
541 before dcommit on will require forcing an overwrite of the existing ref
542 on the remote repository.  This is generally considered bad practice,
543 see the git-push(1) documentation for details.
545 Do not use the --amend option of git-commit(1) on a change you've
546 already dcommitted.  It is considered bad practice to --amend commits
547 you've already pushed to a remote repository for other users, and
548 dcommit with SVN is analogous to that.
550 BUGS
551 ----
553 We ignore all SVN properties except svn:executable.  Any unhandled
554 properties are logged to $GIT_DIR/svn/<refname>/unhandled.log
556 Renamed and copied directories are not detected by git and hence not
557 tracked when committing to SVN.  I do not plan on adding support for
558 this as it's quite difficult and time-consuming to get working for all
559 the possible corner cases (git doesn't do it, either).  Committing
560 renamed and copied files are fully supported if they're similar enough
561 for git to detect them.
563 CONFIGURATION
564 -------------
566 git-svn stores [svn-remote] configuration information in the
567 repository .git/config file.  It is similar the core git
568 [remote] sections except 'fetch' keys do not accept glob
569 arguments; but they are instead handled by the 'branches'
570 and 'tags' keys.  Since some SVN repositories are oddly
571 configured with multiple projects glob expansions such those
572 listed below are allowed:
574 ------------------------------------------------------------------------
575 [svn-remote "project-a"]
576         url = http://server.org/svn
577         branches = branches/*/project-a:refs/remotes/project-a/branches/*
578         tags = tags/*/project-a:refs/remotes/project-a/tags/*
579         trunk = trunk/project-a:refs/remotes/project-a/trunk
580 ------------------------------------------------------------------------
582 Keep in mind that the '*' (asterisk) wildcard of the local ref
583 (right of the ':') *must* be the farthest right path component;
584 however the remote wildcard may be anywhere as long as it's own
585 independent path component (surrounded by '/' or EOL).   This
586 type of configuration is not automatically created by 'init' and
587 should be manually entered with a text-editor or using
588 linkgit:git-config[1]
590 SEE ALSO
591 --------
592 linkgit:git-rebase[1]
594 Author
595 ------
596 Written by Eric Wong <normalperson@yhbt.net>.
598 Documentation
599 -------------
600 Written by Eric Wong <normalperson@yhbt.net>.