blob: 6624a14fbd70992a0bfbba99b73cc2110208c421 [file] [log] [blame]
Eric Wong3397f9d2006-02-16 01:24:16 -08001git-svn(1)
2==========
3
4NAME
5----
Thomas Ackermann2de9b712013-01-21 20:17:53 +01006git-svn - Bidirectional operation between a Subversion repository and Git
Eric Wong3397f9d2006-02-16 01:24:16 -08007
8SYNOPSIS
9--------
Martin von Zweigbergk7791a1d2011-07-01 22:38:26 -040010[verse]
Robert P. J. Dayde613052018-05-24 16:11:39 -040011'git svn' <command> [<options>] [<arguments>]
Eric Wong3397f9d2006-02-16 01:24:16 -080012
13DESCRIPTION
14-----------
Thomas Ackermann2de9b712013-01-21 20:17:53 +010015'git svn' is a simple conduit for changesets between Subversion and Git.
16It provides a bidirectional flow of changes between a Subversion and a Git
Mike Ralphson1168d402008-08-05 17:12:05 +010017repository.
Eric Wong3397f9d2006-02-16 01:24:16 -080018
Yann Dirson647ac702009-07-07 22:22:19 +020019'git svn' can track a standard Subversion repository,
Marc Branchaudab81a362009-06-26 16:49:19 -040020following the common "trunk/branches/tags" layout, with the --stdlayout option.
21It can also follow branches and tags in any layout with the -T/-t/-b options
22(see options to 'init' below, and also the 'clone' command).
Eric Wong3397f9d2006-02-16 01:24:16 -080023
Thomas Ackermann2de9b712013-01-21 20:17:53 +010024Once tracking a Subversion repository (with any of the above methods), the Git
Brian Gernhardt8cb070a2008-07-29 21:16:01 -040025repository can be updated from Subversion by the 'fetch' command and
Thomas Ackermann2de9b712013-01-21 20:17:53 +010026Subversion updated from Git by the 'dcommit' command.
Eric Wong3397f9d2006-02-16 01:24:16 -080027
28COMMANDS
29--------
Jonas Fonseca0ea4d4c2006-08-25 03:07:46 +020030
31'init'::
Thomas Ackermann2de9b712013-01-21 20:17:53 +010032 Initializes an empty Git repository with additional
Yann Dirson647ac702009-07-07 22:22:19 +020033 metadata directories for 'git svn'. The Subversion URL
Eric Wonga836a0e2007-02-14 19:34:56 -080034 may be specified as a command-line argument, or as full
35 URL arguments to -T/-t/-b. Optionally, the target
36 directory to operate on can be specified as a second
37 argument. Normally this command initializes the current
38 directory.
39
Karl Hasselströmcc1793e2007-05-04 09:03:22 +020040-T<trunk_subdir>;;
41--trunk=<trunk_subdir>;;
42-t<tags_subdir>;;
43--tags=<tags_subdir>;;
44-b<branches_subdir>;;
45--branches=<branches_subdir>;;
martin f. krafft8f728fb2007-07-14 11:25:28 +020046-s;;
47--stdlayout;;
Eric Wonga836a0e2007-02-14 19:34:56 -080048 These are optional command-line options for init. Each of
49 these flags can point to a relative repository path
Marc Branchaudab81a362009-06-26 16:49:19 -040050 (--tags=project/tags) or a full url
51 (--tags=https://foo.org/project/tags).
52 You can specify more than one --tags and/or --branches options, in case
53 your Subversion repository places tags or branches under multiple paths.
54 The option --stdlayout is
martin f. krafft8f728fb2007-07-14 11:25:28 +020055 a shorthand way of setting trunk,tags,branches as the relative paths,
56 which is the Subversion default. If any of the other options are given
57 as well, they take precedence.
Karl Hasselströmcc1793e2007-05-04 09:03:22 +020058--no-metadata;;
Eric Wong0dfaf0a2007-02-18 02:34:09 -080059 Set the 'noMetadata' option in the [svn-remote] config.
Eric Wongc9be27f2010-08-21 18:52:14 +000060 This option is not recommended, please read the 'svn.noMetadata'
61 section of this manpage before using this option.
Karl Hasselströmcc1793e2007-05-04 09:03:22 +020062--use-svm-props;;
Eric Wong0dfaf0a2007-02-18 02:34:09 -080063 Set the 'useSvmProps' option in the [svn-remote] config.
Karl Hasselströmcc1793e2007-05-04 09:03:22 +020064--use-svnsync-props;;
Eric Wong0dfaf0a2007-02-18 02:34:09 -080065 Set the 'useSvnsyncProps' option in the [svn-remote] config.
Karl Hasselströmcc1793e2007-05-04 09:03:22 +020066--rewrite-root=<URL>;;
Eric Wong0dfaf0a2007-02-18 02:34:09 -080067 Set the 'rewriteRoot' option in the [svn-remote] config.
Jay Soffian3e18ce12010-01-23 03:30:00 -050068--rewrite-uuid=<UUID>;;
69 Set the 'rewriteUUID' option in the [svn-remote] config.
Michael J Gruber3b0d2402011-02-17 08:48:06 +010070--username=<user>;;
Sam Vilaina0d7fe32007-02-23 12:32:30 +130071 For transports that SVN handles authentication for (http,
72 https, and plain svn), specify the username. For other
Jeff Kingd595bdc2015-05-13 01:06:21 -040073 transports (e.g. `svn+ssh://`), you must include the username in
74 the URL, e.g. `svn+ssh://foo@svn.bar.com/project`
Karl Hasselströmcc1793e2007-05-04 09:03:22 +020075--prefix=<prefix>;;
Eric Wonga836a0e2007-02-14 19:34:56 -080076 This allows one to specify a prefix which is prepended
77 to the names of remotes if trunk/branches/tags are
78 specified. The prefix does not automatically include a
79 trailing slash, so be sure you include one in the
Gerrit Pape0d351e92007-06-19 16:47:41 +000080 argument if that is what you want. If --branches/-b is
81 specified, the prefix must include a trailing slash.
Johan Herland7091a2d2013-10-11 14:57:05 +020082 Setting a prefix (with a trailing slash) is strongly
83 encouraged in any case, as your SVN-tracking refs will
84 then be located at "refs/remotes/$prefix/*", which is
85 compatible with Git's own remote-tracking ref layout
86 (refs/remotes/$remote/*). Setting a prefix is also useful
87 if you wish to track multiple projects that share a common
88 repository.
Johan Herlandfe191fc2013-10-11 14:57:07 +020089 By default, the prefix is set to 'origin/'.
Johan Herlandf849bb62013-10-11 14:57:06 +020090+
Johan Herlandfe191fc2013-10-11 14:57:07 +020091NOTE: Before Git v2.0, the default prefix was "" (no prefix). This
92meant that SVN-tracking refs were put at "refs/remotes/*", which is
93incompatible with how Git's own remote-tracking refs are organized.
Kyle J. McKay7bbc4582014-04-22 04:16:22 -070094If you still want the old default, you can get it by passing
95`--prefix ""` on the command line (`--prefix=""` may not work if
96your Perl's Getopt::Long is < v2.37).
Johan Herlandf849bb62013-10-11 14:57:06 +020097
Andreas Heiduk16fbca02017-06-07 20:32:14 +020098--ignore-refs=<regex>;;
99 When passed to 'init' or 'clone' this regular expression will
100 be preserved as a config key. See 'fetch' for a description
101 of `--ignore-refs`.
Ben Jackson88ec2052009-04-11 10:46:18 -0700102--ignore-paths=<regex>;;
103 When passed to 'init' or 'clone' this regular expression will
104 be preserved as a config key. See 'fetch' for a description
Matthieu Moybcf96262016-06-28 13:40:11 +0200105 of `--ignore-paths`.
Paul Walmsleya7b10232013-05-04 00:10:18 +0100106--include-paths=<regex>;;
107 When passed to 'init' or 'clone' this regular expression will
108 be preserved as a config key. See 'fetch' for a description
Matthieu Moybcf96262016-06-28 13:40:11 +0200109 of `--include-paths`.
Eric Wong6b488292009-07-25 00:00:50 -0700110--no-minimize-url;;
111 When tracking multiple directories (using --stdlayout,
112 --branches, or --tags options), git svn will attempt to connect
113 to the root (or highest allowed level) of the Subversion
114 repository. This default allows better tracking of history if
115 entire projects are moved within a repository, but may cause
116 issues on repositories where read access restrictions are in
Matthieu Moybcf96262016-06-28 13:40:11 +0200117 place. Passing `--no-minimize-url` will allow git svn to
Eric Wong6b488292009-07-25 00:00:50 -0700118 accept URLs as-is without attempting to connect to a higher
119 level directory. This option is off by default when only
120 one URL/branch is tracked (it would do little good).
Eric Wong3397f9d2006-02-16 01:24:16 -0800121
Jonas Fonseca0ea4d4c2006-08-25 03:07:46 +0200122'fetch'::
Eric Wonga836a0e2007-02-14 19:34:56 -0800123 Fetch unfetched revisions from the Subversion remote we are
124 tracking. The name of the [svn-remote "..."] section in the
Keshav Kini6fe7a302013-09-29 18:45:59 -0500125 $GIT_DIR/config file may be specified as an optional
126 command-line argument.
Keshav Kini945b9c12013-09-29 18:46:00 -0500127+
128This automatically updates the rev_map if needed (see
Martin Ågren4c8b8822019-03-06 07:30:17 +0100129'$GIT_DIR/svn/\**/.rev_map.*' in the FILES section below for details).
Eric Wongb705ba42006-02-27 11:04:02 -0800130
Pete Harlane82f0d72009-01-17 20:10:14 -0800131--localtime;;
Jason St. John0ffa1542013-11-08 19:48:52 -0500132 Store Git commit times in the local time zone instead of UTC. This
Yann Dirson647ac702009-07-07 22:22:19 +0200133 makes 'git log' (even without --date=local) show the same times
Jason St. John0ffa1542013-11-08 19:48:52 -0500134 that `svn log` would in the local time zone.
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200135+
Pete Harlane82f0d72009-01-17 20:10:14 -0800136This doesn't interfere with interoperating with the Subversion
137repository you cloned from, but if you wish for your local Git
138repository to be able to interoperate with someone else's local Git
139repository, either don't use this option or you should both use it in
Jason St. John0ffa1542013-11-08 19:48:52 -0500140the same local time zone.
Pete Harlane82f0d72009-01-17 20:10:14 -0800141
Tuomas Suutari61f36a72009-08-14 11:11:58 +0300142--parent;;
143 Fetch only from the SVN parent of the current HEAD.
144
Andreas Heiduk16fbca02017-06-07 20:32:14 +0200145--ignore-refs=<regex>;;
146 Ignore refs for branches or tags matching the Perl regular
147 expression. A "negative look-ahead assertion" like
148 `^refs/remotes/origin/(?!tags/wanted-tag|wanted-branch).*$`
149 can be used to allow only certain refs.
150+
151[verse]
152config key: svn-remote.<name>.ignore-refs
153+
154If the ignore-refs configuration key is set, and the command-line
155option is also given, both regular expressions will be used.
156
Vitaly \"_Vi\" Shukela6076b842009-01-26 00:21:41 +0200157--ignore-paths=<regex>;;
Ben Jackson0d8bee72009-04-11 10:46:17 -0700158 This allows one to specify a Perl regular expression that will
Vitaly \"_Vi\" Shukela6076b842009-01-26 00:21:41 +0200159 cause skipping of all matching paths from checkout from SVN.
Matthieu Moybcf96262016-06-28 13:40:11 +0200160 The `--ignore-paths` option should match for every 'fetch'
Ben Jackson0d8bee72009-04-11 10:46:17 -0700161 (including automatic fetches due to 'clone', 'dcommit',
162 'rebase', etc) on a given repository.
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200163+
164[verse]
Ben Jackson0d8bee72009-04-11 10:46:17 -0700165config key: svn-remote.<name>.ignore-paths
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200166+
Jason St. John06ab60c2014-05-21 14:52:26 -0400167If the ignore-paths configuration key is set, and the command-line
168option is also given, both regular expressions will be used.
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200169+
Ben Jackson0d8bee72009-04-11 10:46:17 -0700170Examples:
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200171+
172--
173Skip "doc*" directory for every fetch;;
174+
175------------------------------------------------------------------------
176--ignore-paths="^doc"
177------------------------------------------------------------------------
Ben Jackson0d8bee72009-04-11 10:46:17 -0700178
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200179Skip "branches" and "tags" of first level directories;;
180+
181------------------------------------------------------------------------
182--ignore-paths="^[^/]+/(?:branches|tags)"
183------------------------------------------------------------------------
184--
Vitaly \"_Vi\" Shukela6076b842009-01-26 00:21:41 +0200185
Paul Walmsleya7b10232013-05-04 00:10:18 +0100186--include-paths=<regex>;;
187 This allows one to specify a Perl regular expression that will
188 cause the inclusion of only matching paths from checkout from SVN.
Matthieu Moybcf96262016-06-28 13:40:11 +0200189 The `--include-paths` option should match for every 'fetch'
Paul Walmsleya7b10232013-05-04 00:10:18 +0100190 (including automatic fetches due to 'clone', 'dcommit',
Matthieu Moybcf96262016-06-28 13:40:11 +0200191 'rebase', etc) on a given repository. `--ignore-paths` takes
192 precedence over `--include-paths`.
Brett Randall486e1e12015-08-24 10:23:45 +1000193+
194[verse]
195config key: svn-remote.<name>.include-paths
Paul Walmsleya7b10232013-05-04 00:10:18 +0100196
Gunnlaugur Þór Briembc22b272012-10-23 10:33:26 +0000197--log-window-size=<n>;;
Stefan Beller3c123fb2013-10-21 21:36:06 +0200198 Fetch <n> log entries per request when scanning Subversion history.
199 The default is 100. For very large Subversion repositories, larger
200 values may be needed for 'clone'/'fetch' to complete in reasonable
201 time. But overly large values may lead to higher memory usage and
202 request timeouts.
Gunnlaugur Þór Briembc22b272012-10-23 10:33:26 +0000203
Eric Wonga81ed0b2007-02-18 02:10:51 -0800204'clone'::
205 Runs 'init' and 'fetch'. It will automatically create a
206 directory based on the basename of the URL passed to it;
207 or if a second argument is passed; it will create a directory
208 and work within that. It accepts all arguments that the
209 'init' and 'fetch' commands accept; with the exception of
Matthieu Moybcf96262016-06-28 13:40:11 +0200210 `--fetch-all` and `--parent`. After a repository is cloned,
Yann Dirson0da3e1d2009-07-07 22:22:22 +0200211 the 'fetch' command will be able to update revisions without
212 affecting the working tree; and the 'rebase' command will be
213 able to update the working tree with the latest changes.
Eric Wonga81ed0b2007-02-18 02:10:51 -0800214
Ray Chen40a15302011-07-20 18:37:26 -0400215--preserve-empty-dirs;;
216 Create a placeholder file in the local Git repository for each
217 empty directory fetched from Subversion. This includes directories
218 that become empty by removing all entries in the Subversion
219 repository (but not the directory itself). The placeholder files
220 are also tracked and removed when no longer necessary.
221
222--placeholder-filename=<filename>;;
223 Set the name of placeholder files created by --preserve-empty-dirs.
224 Default: ".gitignore"
225
Eric Wonga81ed0b2007-02-18 02:10:51 -0800226'rebase'::
227 This fetches revisions from the SVN parent of the current HEAD
228 and rebases the current (uncommitted to SVN) work against it.
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200229+
Yann Dirson647ac702009-07-07 22:22:19 +0200230This works similarly to `svn update` or 'git pull' except that
231it preserves linear history with 'git rebase' instead of
232'git merge' for ease of dcommitting with 'git svn'.
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200233+
Yann Dirson647ac702009-07-07 22:22:19 +0200234This accepts all options that 'git svn fetch' and 'git rebase'
Matthieu Moybcf96262016-06-28 13:40:11 +0200235accept. However, `--fetch-all` only fetches from the current
Sergey Vlasov112f6382007-03-01 22:41:17 +0300236[svn-remote], and not all [svn-remote] definitions.
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200237+
Yann Dirson647ac702009-07-07 22:22:19 +0200238Like 'git rebase'; this requires that the working tree be clean
Sergey Vlasov112f6382007-03-01 22:41:17 +0300239and have no uncommitted changes.
Keshav Kini945b9c12013-09-29 18:46:00 -0500240+
241This automatically updates the rev_map if needed (see
Martin Ågren4c8b8822019-03-06 07:30:17 +0100242'$GIT_DIR/svn/\**/.rev_map.*' in the FILES section below for details).
Karl Hasselströmcc1793e2007-05-04 09:03:22 +0200243
Eric Wongdee41f32007-03-13 11:40:36 -0700244-l;;
245--local;;
Yann Dirson647ac702009-07-07 22:22:19 +0200246 Do not fetch remotely; only run 'git rebase' against the
Eric Wongdee41f32007-03-13 11:40:36 -0700247 last fetched commit from the upstream SVN.
Eric Wonga81ed0b2007-02-18 02:10:51 -0800248
Eric Wongb22d4492006-08-26 00:01:23 -0700249'dcommit'::
Jon Seymour2b26b65f2012-05-17 13:20:43 +1000250 Commit each diff from the current branch directly to the SVN
Eric Wongb22d4492006-08-26 00:01:23 -0700251 repository, and then rebase or reset (depending on whether or
Eric Wong2eff1422007-01-06 17:53:40 -0800252 not there is a diff between SVN and head). This will create
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100253 a revision in SVN for each commit in Git.
Jon Seymour2b26b65f2012-05-17 13:20:43 +1000254+
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100255When an optional Git branch name (or a Git commit object name)
Jon Seymour2b26b65f2012-05-17 13:20:43 +1000256is specified as an argument, the subcommand works on the specified
257branch, not on the current branch.
258+
259Use of 'dcommit' is preferred to 'set-tree' (below).
Karl Hasselström171af112007-05-03 07:51:35 +0200260+
261--no-rebase;;
262 After committing, do not rebase or reset.
Eric Wongba24e742008-08-07 02:06:16 -0700263--commit-url <URL>;;
264 Commit to this SVN URL (the full path). This is intended to
Yann Dirson647ac702009-07-07 22:22:19 +0200265 allow existing 'git svn' repositories created with one transport
Eric Wongba24e742008-08-07 02:06:16 -0700266 method (e.g. `svn://` or `http://` for anonymous read) to be
267 reused if a user is later given access to an alternate transport
268 method (e.g. `svn+ssh://` or `https://`) for commit.
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200269+
270[verse]
Peter Oberndorfer0df84052009-02-23 12:02:53 +0100271config key: svn-remote.<name>.commiturl
Peter Oberndorfer0df84052009-02-23 12:02:53 +0100272config key: svn.commiturl (overwrites all svn-remote.<name>.commiturl options)
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200273+
Sveinung Kvilhaugsvikf947ae42014-10-10 00:49:59 +0200274Note that the SVN URL of the commiturl config key includes the SVN branch.
275If you rather want to set the commit URL for an entire SVN repository use
276svn-remote.<name>.pushurl instead.
277+
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200278Using this option for any other purpose (don't ask) is very strongly
279discouraged.
Eric Wongb22d4492006-08-26 00:01:23 -0700280
Michael J Gruberccc2fcf2011-04-19 14:24:27 +0200281--mergeinfo=<mergeinfo>;;
282 Add the given merge information during the dcommit
283 (e.g. `--mergeinfo="/branches/foo:1-10"`). All svn server versions can
284 store this information (as a property), and svn clients starting from
Bryan Jacobs98c4ab32011-08-31 12:48:39 -0400285 version 1.5 can make use of it. To specify merge information from multiple
286 branches, use a single space character between the branches
287 (`--mergeinfo="/branches/foo:1-10 /branches/bar:3,5-6,8"`)
Bryan Jacobs1e5814f2011-09-07 13:36:05 -0400288+
289[verse]
290config key: svn.pushmergeinfo
291+
292This option will cause git-svn to attempt to automatically populate the
293svn:mergeinfo property in the SVN repository when possible. Currently, this can
294only be done when dcommitting non-fast-forward merges where all parents but the
295first have already been pushed into SVN.
Michael J Gruberccc2fcf2011-04-19 14:24:27 +0200296
Frédéric Heitzmannafd7f1e2011-09-16 23:02:01 +0200297--interactive;;
298 Ask the user to confirm that a patch set should actually be sent to SVN.
299 For each patch, one may answer "yes" (accept this patch), "no" (discard this
300 patch), "all" (accept all patches), or "quit".
Jeff King5a8a19e2015-05-13 00:58:16 -0400301+
302'git svn dcommit' returns immediately if answer is "no" or "quit", without
303committing anything to SVN.
Frédéric Heitzmannafd7f1e2011-09-16 23:02:01 +0200304
Florian Ragwitz5de70ef2008-10-04 19:35:17 -0700305'branch'::
306 Create a branch in the SVN repository.
307
308-m;;
309--message;;
310 Allows to specify the commit message.
311
312-t;;
313--tag;;
314 Create a tag by using the tags_subdir instead of the branches_subdir
315 specified during git svn init.
316
Jonathan Nieder7d82b4a2011-12-19 19:24:30 -0600317-d<path>;;
318--destination=<path>;;
319
Marc Branchaudab81a362009-06-26 16:49:19 -0400320 If more than one --branches (or --tags) option was given to the 'init'
321 or 'clone' command, you must provide the location of the branch (or
Jonathan Nieder7d82b4a2011-12-19 19:24:30 -0600322 tag) you wish to create in the SVN repository. <path> specifies which
323 path to use to create the branch or tag and should match the pattern
324 on the left-hand side of one of the configured branches or tags
325 refspecs. You can see these refspecs with the commands
Marc Branchaudab81a362009-06-26 16:49:19 -0400326+
327 git config --get-all svn-remote.<name>.branches
328 git config --get-all svn-remote.<name>.tags
329+
330where <name> is the name of the SVN repository as specified by the -R option to
331'init' (or "svn" by default).
332
Igor Mironova65f3c22010-01-12 03:22:27 +1100333--username;;
334 Specify the SVN username to perform the commit as. This option overrides
Ævar Arnfjörð Bjarmasoncb82dbf2010-05-07 19:50:03 +0000335 the 'username' configuration property.
Igor Mironova65f3c22010-01-12 03:22:27 +1100336
337--commit-url;;
338 Use the specified URL to connect to the destination Subversion
339 repository. This is useful in cases where the source SVN
340 repository is read-only. This option overrides configuration
341 property 'commiturl'.
342+
343 git config --get-all svn-remote.<name>.commiturl
344+
345
Tobias Schultef4f4c7f2013-05-15 22:14:43 +0200346--parents;;
347 Create parent folders. This parameter is equivalent to the parameter
348 --parents on svn cp commands and is useful for non-standard repository
349 layouts.
350
Florian Ragwitz5de70ef2008-10-04 19:35:17 -0700351'tag'::
352 Create a tag in the SVN repository. This is a shorthand for
353 'branch -t'.
354
Eric Wonge8f5d902006-10-11 14:53:35 -0700355'log'::
356 This should make it easy to look up svn log messages when svn
357 users refer to -r/--revision numbers.
Sergey Vlasov112f6382007-03-01 22:41:17 +0300358+
359The following features from `svn log' are supported:
360+
361--
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200362-r <n>[:<n>];;
363--revision=<n>[:<n>];;
Sergey Vlasov112f6382007-03-01 22:41:17 +0300364 is supported, non-numeric args are not:
365 HEAD, NEXT, BASE, PREV, etc ...
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200366-v;;
367--verbose;;
Sergey Vlasov112f6382007-03-01 22:41:17 +0300368 it's not completely compatible with the --verbose
369 output in svn log, but reasonably close.
370--limit=<n>;;
371 is NOT the same as --max-count, doesn't count
372 merged/excluded commits
373--incremental;;
374 supported
375--
376+
377New features:
378+
379--
380--show-commit;;
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100381 shows the Git commit sha1, as well
Sergey Vlasov112f6382007-03-01 22:41:17 +0300382--oneline;;
383 our version of --pretty=oneline
384--
385+
Miklos Vajnaa50a5c82008-02-27 14:13:00 +0100386NOTE: SVN itself only stores times in UTC and nothing else. The regular svn
387client converts the UTC time to the local time (or based on the TZ=
388environment). This command has the same behaviour.
389+
Yann Dirson647ac702009-07-07 22:22:19 +0200390Any other arguments are passed directly to 'git log'
Eric Wonge8f5d902006-10-11 14:53:35 -0700391
Tim Stoakes6fb53752008-02-10 15:21:08 +1030392'blame'::
Stefan Beller3c123fb2013-10-21 21:36:06 +0200393 Show what revision and author last modified each line of a file. The
394 output of this mode is format-compatible with the output of
395 `svn blame' by default. Like the SVN blame command,
396 local uncommitted changes in the working tree are ignored;
397 the version of the file in the HEAD revision is annotated. Unknown
398 arguments are passed directly to 'git blame'.
Tim Stoakes6fb53752008-02-10 15:21:08 +1030399+
Steven Grimm4be40382008-05-10 22:11:18 -0700400--git-format;;
Yann Dirson647ac702009-07-07 22:22:19 +0200401 Produce output in the same format as 'git blame', but with
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100402 SVN revision numbers instead of Git commit hashes. In this mode,
Steven Grimm4be40382008-05-10 22:11:18 -0700403 changes that haven't been committed to SVN (including local
404 working-copy edits) are shown as revision 0.
Tim Stoakes6fb53752008-02-10 15:21:08 +1030405
Adam Roben26e60162007-04-27 11:57:53 -0700406'find-rev'::
407 When given an SVN revision number of the form 'rN', returns the
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100408 corresponding Git commit hash (this can optionally be followed by a
Adam Robenb3cb7e42007-04-29 01:35:27 -0700409 tree-ish to specify which branch should be searched). When given a
410 tree-ish, returns the corresponding SVN revision number.
John Keeping2934a482013-01-17 22:19:33 +0000411+
Eric Wonga831a3f2014-09-07 08:35:19 +0000412-B;;
John Keeping2934a482013-01-17 22:19:33 +0000413--before;;
414 Don't require an exact match if given an SVN revision, instead find
415 the commit corresponding to the state of the SVN repository (on the
416 current branch) at the specified revision.
417+
Eric Wonga831a3f2014-09-07 08:35:19 +0000418-A;;
John Keeping2934a482013-01-17 22:19:33 +0000419--after;;
420 Don't require an exact match if given an SVN revision; if there is
421 not an exact match return the closest match searching forward in the
422 history.
Adam Roben26e60162007-04-27 11:57:53 -0700423
Eric Wong3289e862006-12-15 23:58:08 -0800424'set-tree'::
Eric Wonge8f5d902006-10-11 14:53:35 -0700425 You should consider using 'dcommit' instead of this command.
Eric Wong3397f9d2006-02-16 01:24:16 -0800426 Commit specified commit or tree objects to SVN. This relies on
Martin Ågren7560f542017-08-23 19:49:35 +0200427 your imported fetch data being up to date. This makes
Eric Wong3397f9d2006-02-16 01:24:16 -0800428 absolutely no attempts to do patching when committing to SVN, it
429 simply overwrites files with those specified in the tree or
430 commit. All merging is assumed to have taken place
Yann Dirson647ac702009-07-07 22:22:19 +0200431 independently of 'git svn' functions.
Eric Wong3397f9d2006-02-16 01:24:16 -0800432
Gustaf Hendebyda060c62008-05-05 00:33:10 +0200433'create-ignore'::
Gustaf Hendebyda060c62008-05-05 00:33:10 +0200434 Recursively finds the svn:ignore property on directories and
435 creates matching .gitignore files. The resulting files are staged to
Gustaf Hendeby69239722008-05-20 00:47:28 +0200436 be committed, but are not committed. Use -r/--revision to refer to a
Mike Ralphson1168d402008-08-05 17:12:05 +0100437 specific revision.
Gustaf Hendebyda060c62008-05-05 00:33:10 +0200438
Jonas Fonseca0ea4d4c2006-08-25 03:07:46 +0200439'show-ignore'::
Eric Wong8f225622006-02-26 02:22:27 -0800440 Recursively finds and lists the svn:ignore property on
441 directories. The output is suitable for appending to
442 the $GIT_DIR/info/exclude file.
443
Eric Wong6111b932009-11-15 18:57:16 -0800444'mkdirs'::
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100445 Attempts to recreate empty directories that core Git cannot track
Eric Wong6111b932009-11-15 18:57:16 -0800446 based on information in $GIT_DIR/svn/<refname>/unhandled.log files.
447 Empty directories are automatically recreated when using
448 "git svn clone" and "git svn rebase", so "mkdirs" is intended
449 for use after commands like "git checkout" or "git reset".
Michael Haggerty55f9d7a2011-04-01 12:26:00 +0200450 (See the svn-remote.<name>.automkdirs config file option for
451 more information.)
Eric Wong6111b932009-11-15 18:57:16 -0800452
Eric Wonge8f5d902006-10-11 14:53:35 -0700453'commit-diff'::
454 Commits the diff of two tree-ish arguments from the
Ville Skyttä928f0ab2018-06-22 09:50:37 +0300455 command-line. This command does not rely on being inside a `git svn
Jonathan Nieder483bc4f2008-06-30 13:56:34 -0500456 init`-ed repository. This command takes three arguments, (a) the
Eric Wonge8f5d902006-10-11 14:53:35 -0700457 original tree to diff against, (b) the new tree result, (c) the
458 URL of the target Subversion repository. The final argument
Yann Dirson647ac702009-07-07 22:22:19 +0200459 (URL) may be omitted if you are working from a 'git svn'-aware
460 repository (that has been `init`-ed with 'git svn').
Eric Wong45bf4732006-11-09 01:19:37 -0800461 The -r<revision> option is required for this.
Andreas Heidukda446102017-06-14 11:31:38 +0200462+
463The commit message is supplied either directly with the `-m` or `-F`
464option, or indirectly from the tag or commit when the second tree-ish
465denotes such an object, or it is requested by invoking an editor (see
466`--edit` option below).
467
468-m <msg>;;
469--message=<msg>;;
470 Use the given `msg` as the commit message. This option
471 disables the `--edit` option.
472
473-F <filename>;;
474--file=<filename>;;
475 Take the commit message from the given file. This option
476 disables the `--edit` option.
Eric Wonge8f5d902006-10-11 14:53:35 -0700477
David D. Kilzere6fefa92007-11-21 11:57:18 -0800478'info'::
479 Shows information about a file or directory similar to what
480 `svn info' provides. Does not currently support a -r/--revision
David D. Kilzer8b014d72007-11-21 11:57:19 -0800481 argument. Use the --url option to output only the value of the
482 'URL:' field.
David D. Kilzere6fefa92007-11-21 11:57:18 -0800483
Gustaf Hendeby69239722008-05-20 00:47:28 +0200484'proplist'::
485 Lists the properties stored in the Subversion repository about a
486 given file or directory. Use -r/--revision to refer to a specific
487 Subversion revision.
488
489'propget'::
490 Gets the Subversion property given as the first argument, for a
491 file. A specific revision can be specified with -r/--revision.
492
Alfred Perlstein19a7f242016-06-14 22:19:50 -0700493'propset'::
494 Sets the Subversion property given as the first argument, to the
495 value given as the second argument for the file given as the
496 third argument.
497+
498Example:
499+
500------------------------------------------------------------------------
501git svn propset svn:keywords "FreeBSD=%H" devel/py-tipper/Makefile
502------------------------------------------------------------------------
503+
504This will set the property 'svn:keywords' to 'FreeBSD=%H' for the file
505'devel/py-tipper/Makefile'.
506
Gustaf Hendeby69239722008-05-20 00:47:28 +0200507'show-externals'::
508 Shows the Subversion externals. Use -r/--revision to specify a
509 specific revision.
510
Robert Allan Zeh2da9ee02009-07-19 18:00:52 -0500511'gc'::
Keshav Kinie618c392013-09-29 18:45:58 -0500512 Compress $GIT_DIR/svn/<refname>/unhandled.log files and remove
513 $GIT_DIR/svn/<refname>/index files.
Robert Allan Zeh2da9ee02009-07-19 18:00:52 -0500514
Ben Jackson195643f2009-06-03 20:45:52 -0700515'reset'::
516 Undoes the effects of 'fetch' back to the specified revision.
517 This allows you to re-'fetch' an SVN revision. Normally the
518 contents of an SVN revision should never change and 'reset'
519 should not be necessary. However, if SVN permissions change,
520 or if you alter your --ignore-paths option, a 'fetch' may fail
521 with "not found in commit" (file not previously visible) or
522 "checksum mismatch" (missed a modification). If the problem
523 file cannot be ignored forever (with --ignore-paths) the only
524 way to repair the repo is to use 'reset'.
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200525+
Keshav Kini945b9c12013-09-29 18:46:00 -0500526Only the rev_map and refs/remotes/git-svn are changed (see
Martin Ågren4c8b8822019-03-06 07:30:17 +0100527'$GIT_DIR/svn/\**/.rev_map.*' in the FILES section below for details).
Keshav Kini945b9c12013-09-29 18:46:00 -0500528Follow 'reset' with a 'fetch' and then 'git reset' or 'git rebase' to
529move local branches onto the new tree.
Ben Jackson195643f2009-06-03 20:45:52 -0700530
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200531-r <n>;;
532--revision=<n>;;
Ben Jackson195643f2009-06-03 20:45:52 -0700533 Specify the most recent revision to keep. All later revisions
534 are discarded.
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200535-p;;
536--parent;;
Ben Jackson195643f2009-06-03 20:45:52 -0700537 Discard the specified revision as well, keeping the nearest
538 parent instead.
539Example:;;
540Assume you have local changes in "master", but you need to refetch "r2".
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200541+
Ben Jackson195643f2009-06-03 20:45:52 -0700542------------
543 r1---r2---r3 remotes/git-svn
544 \
545 A---B master
546------------
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200547+
Ben Jackson195643f2009-06-03 20:45:52 -0700548Fix the ignore-paths or SVN permissions problem that caused "r2" to
549be incomplete in the first place. Then:
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200550+
Ben Jackson195643f2009-06-03 20:45:52 -0700551[verse]
552git svn reset -r2 -p
553git svn fetch
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200554+
Ben Jackson195643f2009-06-03 20:45:52 -0700555------------
556 r1---r2'--r3' remotes/git-svn
557 \
558 r2---r3---A---B master
559------------
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200560+
Yann Dirson647ac702009-07-07 22:22:19 +0200561Then fixup "master" with 'git rebase'.
562Do NOT use 'git merge' or your history will not be compatible with a
Ben Jackson195643f2009-06-03 20:45:52 -0700563future 'dcommit'!
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200564+
Ben Jackson195643f2009-06-03 20:45:52 -0700565[verse]
566git rebase --onto remotes/git-svn A^ master
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200567+
Ben Jackson195643f2009-06-03 20:45:52 -0700568------------
569 r1---r2'--r3' remotes/git-svn
570 \
571 A'--B' master
572------------
573
Eric Wong3397f9d2006-02-16 01:24:16 -0800574OPTIONS
575-------
Jonas Fonseca0ea4d4c2006-08-25 03:07:46 +0200576
Štěpán Němec0adda932010-10-08 19:31:17 +0200577--shared[=(false|true|umask|group|all|world|everybody)]::
Eric Wonge8f5d902006-10-11 14:53:35 -0700578--template=<template_directory>::
579 Only used with the 'init' command.
Yann Dirson647ac702009-07-07 22:22:19 +0200580 These are passed directly to 'git init'.
Eric Wonge8f5d902006-10-11 14:53:35 -0700581
Michael J Gruber3b0d2402011-02-17 08:48:06 +0100582-r <arg>::
583--revision <arg>::
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200584 Used with the 'fetch' command.
585+
Eric Wonga836a0e2007-02-14 19:34:56 -0800586This allows revision ranges for partial/cauterized history
587to be supported. $NUMBER, $NUMBER1:$NUMBER2 (numeric ranges),
588$NUMBER:HEAD, and BASE:$NUMBER are all supported.
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200589+
Eric Wonga836a0e2007-02-14 19:34:56 -0800590This can allow you to make partial mirrors when running fetch;
591but is generally not recommended because history will be skipped
592and lost.
Eric Wong3397f9d2006-02-16 01:24:16 -0800593
594-::
595--stdin::
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200596 Only used with the 'set-tree' command.
597+
Jonas Fonseca0ea4d4c2006-08-25 03:07:46 +0200598Read a list of commits from stdin and commit them in reverse
599order. Only the leading sha1 is read from each line, so
Yann Dirson647ac702009-07-07 22:22:19 +0200600'git rev-list --pretty=oneline' output can be used.
Eric Wong3397f9d2006-02-16 01:24:16 -0800601
602--rmdir::
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200603 Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
604+
Jonas Fonseca0ea4d4c2006-08-25 03:07:46 +0200605Remove directories from the SVN tree if there are no files left
606behind. SVN can version empty directories, and they are not
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100607removed by default if there are no files left in them. Git
Jonas Fonseca0ea4d4c2006-08-25 03:07:46 +0200608cannot version empty directories. Enabling this flag will make
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100609the commit to SVN act like Git.
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200610+
611[verse]
Tom Princee0d10e12007-01-28 16:16:53 -0800612config key: svn.rmdir
Eric Wong20b1d702006-04-01 18:25:03 -0800613
Eric Wong3397f9d2006-02-16 01:24:16 -0800614-e::
615--edit::
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200616 Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
617+
Jonas Fonseca0ea4d4c2006-08-25 03:07:46 +0200618Edit the commit message before committing to SVN. This is off by
619default for objects that are commits, and forced on when committing
620tree objects.
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200621+
622[verse]
Tom Princee0d10e12007-01-28 16:16:53 -0800623config key: svn.edit
Eric Wong20b1d702006-04-01 18:25:03 -0800624
Eric Wong72942932006-02-20 10:57:26 -0800625-l<num>::
626--find-copies-harder::
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200627 Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
628+
Yann Dirson647ac702009-07-07 22:22:19 +0200629They are both passed directly to 'git diff-tree'; see
Dan McGee5162e692007-12-29 00:20:38 -0600630linkgit:git-diff-tree[1] for more information.
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200631+
Jonas Fonseca0ea4d4c2006-08-25 03:07:46 +0200632[verse]
Tom Princee0d10e12007-01-28 16:16:53 -0800633config key: svn.l
634config key: svn.findcopiesharder
Eric Wong20b1d702006-04-01 18:25:03 -0800635
Eric Wong81c5a0e2006-05-05 12:35:39 -0700636-A<filename>::
637--authors-file=<filename>::
Andreas Heidukcb427e92018-03-24 11:20:46 +0100638 Syntax is compatible with the file used by 'git cvsimport' but
639 an empty email address can be supplied with '<>':
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200640+
Eric Wong81c5a0e2006-05-05 12:35:39 -0700641------------------------------------------------------------------------
Jonas Fonseca0ea4d4c2006-08-25 03:07:46 +0200642 loginname = Joe User <user@example.com>
Eric Wong81c5a0e2006-05-05 12:35:39 -0700643------------------------------------------------------------------------
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200644+
Yann Dirson647ac702009-07-07 22:22:19 +0200645If this option is specified and 'git svn' encounters an SVN
646committer name that does not exist in the authors-file, 'git svn'
Jonas Fonseca0ea4d4c2006-08-25 03:07:46 +0200647will abort operation. The user will then have to add the
Yann Dirson647ac702009-07-07 22:22:19 +0200648appropriate entry. Re-running the previous 'git svn' command
Jonas Fonseca0ea4d4c2006-08-25 03:07:46 +0200649after the authors-file is modified should continue operation.
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200650+
651[verse]
Tom Princee0d10e12007-01-28 16:16:53 -0800652config key: svn.authorsfile
Eric Wonge8f5d902006-10-11 14:53:35 -0700653
Mark Lodato36db1ed2009-05-14 21:27:15 -0400654--authors-prog=<filename>::
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200655 If this option is specified, for each SVN committer name that
656 does not exist in the authors file, the given file is executed
657 with the committer name as the first argument. The program is
Andreas Heidukcb427e92018-03-24 11:20:46 +0100658 expected to return a single line of the form "Name <email>" or
659 "Name <>", which will be treated as if included in the authors
660 file.
Eric Wongcec92642016-07-19 10:02:39 +0000661+
Andreas Heiduk9c183982018-03-04 12:22:36 +0100662Due to historical reasons a relative 'filename' is first searched
663relative to the current directory for 'init' and 'clone' and relative
664to the root of the working tree for 'fetch'. If 'filename' is
665not found, it is searched like any other command in '$PATH'.
666+
Eric Wongcec92642016-07-19 10:02:39 +0000667[verse]
668config key: svn.authorsProg
Mark Lodato36db1ed2009-05-14 21:27:15 -0400669
Eric Wonge8f5d902006-10-11 14:53:35 -0700670-q::
671--quiet::
Yann Dirson647ac702009-07-07 22:22:19 +0200672 Make 'git svn' less verbose. Specify a second time to make it
Simon Arlott49750f32009-03-30 19:31:41 +0100673 even less verbose.
Eric Wonge8f5d902006-10-11 14:53:35 -0700674
Eric Wongb22d4492006-08-26 00:01:23 -0700675-m::
676--merge::
677-s<strategy>::
678--strategy=<strategy>::
Avishay Lavieb64e1f52012-05-15 11:45:50 +0300679-p::
Johannes Schindelinea8b7be2019-11-22 22:59:29 +0000680--rebase-merges::
681--preserve-merges (DEPRECATED)::
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200682 These are only used with the 'dcommit' and 'rebase' commands.
683+
Yann Dirson647ac702009-07-07 22:22:19 +0200684Passed directly to 'git rebase' when using 'dcommit' if a
685'git reset' cannot be used (see 'dcommit').
Eric Wongb22d4492006-08-26 00:01:23 -0700686
687-n::
688--dry-run::
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200689 This can be used with the 'dcommit', 'rebase', 'branch' and
690 'tag' commands.
691+
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100692For 'dcommit', print out the series of Git arguments that would show
Eric Wongb22d4492006-08-26 00:01:23 -0700693which diffs would be committed to SVN.
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200694+
Seth Falcon7d45e142008-05-19 20:29:17 -0700695For 'rebase', display the local branch associated with the upstream svn
696repository associated with the current branch and the URL of svn
697repository that will be fetched from.
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200698+
Florian Ragwitz5de70ef2008-10-04 19:35:17 -0700699For 'branch' and 'tag', display the urls that will be used for copying when
700creating the branch or tag.
701
Valentin Haenelc88d18f2011-04-26 13:34:18 +0200702--use-log-author::
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100703 When retrieving svn commits into Git (as part of 'fetch', 'rebase', or
Valentin Haenel7733b272011-04-26 13:34:19 +0200704 'dcommit' operations), look for the first `From:` or `Signed-off-by:` line
Valentin Haenelc88d18f2011-04-26 13:34:18 +0200705 in the log message and use that as the author string.
Eric Wongea9a93d2016-12-11 00:06:46 +0000706+
707[verse]
708config key: svn.useLogAuthor
709
Valentin Haenelc88d18f2011-04-26 13:34:18 +0200710--add-author-from::
Andreas Heiduk43d7f2d2018-05-03 20:48:28 +0200711 When committing to svn from Git (as part of 'set-tree' or 'dcommit'
Valentin Haenelc88d18f2011-04-26 13:34:18 +0200712 operations), if the existing log message doesn't already have a
Valentin Haenel7733b272011-04-26 13:34:19 +0200713 `From:` or `Signed-off-by:` line, append a `From:` line based on the
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100714 Git commit's author string. If you use this, then `--use-log-author`
Valentin Haenelc88d18f2011-04-26 13:34:18 +0200715 will retrieve a valid author string for all commits.
Eric Wongea9a93d2016-12-11 00:06:46 +0000716+
717[verse]
718config key: svn.addAuthorFrom
Eric Wong81c5a0e2006-05-05 12:35:39 -0700719
Eric Wong448c81b2006-03-03 01:20:09 -0800720ADVANCED OPTIONS
721----------------
Jonas Fonseca0ea4d4c2006-08-25 03:07:46 +0200722
Eric Wong448c81b2006-03-03 01:20:09 -0800723-i<GIT_SVN_ID>::
724--id <GIT_SVN_ID>::
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200725 This sets GIT_SVN_ID (instead of using the environment). This
726 allows the user to override the default refname to fetch from
727 when tracking a single URL. The 'log' and 'dcommit' commands
728 no longer require this switch as an argument.
Jonas Fonseca0ea4d4c2006-08-25 03:07:46 +0200729
Eric Wong9760adc2007-01-31 03:06:56 -0800730-R<remote name>::
731--svn-remote <remote name>::
732 Specify the [svn-remote "<remote name>"] section to use,
Eric Wonga836a0e2007-02-14 19:34:56 -0800733 this allows SVN multiple repositories to be tracked.
734 Default: "svn"
Eric Wong9760adc2007-01-31 03:06:56 -0800735
Eric Wonge8f5d902006-10-11 14:53:35 -0700736--follow-parent::
Sebastian Leske0d35bfe2012-11-30 08:16:30 +0100737 This option is only relevant if we are tracking branches (using
738 one of the repository layout options --trunk, --tags,
739 --branches, --stdlayout). For each tracked branch, try to find
740 out where its revision was copied from, and set
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100741 a suitable parent in the first Git commit for the branch.
Eric Wonge8f5d902006-10-11 14:53:35 -0700742 This is especially helpful when we're tracking a directory
Sebastian Leske0d35bfe2012-11-30 08:16:30 +0100743 that has been moved around within the repository. If this
744 feature is disabled, the branches created by 'git svn' will all
745 be linear and not share any history, meaning that there will be
746 no information on where branches were branched off or merged.
747 However, following long/convoluted histories can take a long
748 time, so disabling this feature may speed up the cloning
749 process. This feature is enabled by default, use
Eric Wong0bed5ea2007-02-09 02:45:03 -0800750 --no-follow-parent to disable it.
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200751+
752[verse]
Tom Princee0d10e12007-01-28 16:16:53 -0800753config key: svn.followparent
Eric Wonge8f5d902006-10-11 14:53:35 -0700754
Eric Wonga81ed0b2007-02-18 02:10:51 -0800755CONFIG FILE-ONLY OPTIONS
756------------------------
Eric Wonga81ed0b2007-02-18 02:10:51 -0800757
Eric Wong0dfaf0a2007-02-18 02:34:09 -0800758svn.noMetadata::
759svn-remote.<name>.noMetadata::
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200760 This gets rid of the 'git-svn-id:' lines at the end of every commit.
761+
Eric Wongc9be27f2010-08-21 18:52:14 +0000762This option can only be used for one-shot imports as 'git svn'
763will not be able to fetch again without metadata. Additionally,
Martin Ågren4c8b8822019-03-06 07:30:17 +0100764if you lose your '$GIT_DIR/svn/\**/.rev_map.*' files, 'git svn' will not
Eric Wongc9be27f2010-08-21 18:52:14 +0000765be able to rebuild them.
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200766+
Yann Dirson647ac702009-07-07 22:22:19 +0200767The 'git svn log' command will not work on repositories using
Sergey Vlasov112f6382007-03-01 22:41:17 +0300768this, either. Using this conflicts with the 'useSvmProps'
769option for (hopefully) obvious reasons.
Eric Wongc9be27f2010-08-21 18:52:14 +0000770+
771This option is NOT recommended as it makes it difficult to track down
772old references to SVN revision numbers in existing documentation, bug
Elijah Newren9df53c52019-09-04 15:32:38 -0700773reports, and archives. If you plan to eventually migrate from SVN to
774Git and are certain about dropping SVN history, consider
775https://github.com/newren/git-filter-repo[git-filter-repo] instead.
776filter-repo also allows reformatting of metadata for ease-of-reading
777and rewriting authorship info for non-"svn.authorsFile" users.
Eric Wonge8f5d902006-10-11 14:53:35 -0700778
Eric Wong0dfaf0a2007-02-18 02:34:09 -0800779svn.useSvmProps::
780svn-remote.<name>.useSvmProps::
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200781 This allows 'git svn' to re-map repository URLs and UUIDs from
782 mirrors created using SVN::Mirror (or svk) for metadata.
783+
Sergey Vlasov112f6382007-03-01 22:41:17 +0300784If an SVN revision has a property, "svm:headrev", it is likely
785that the revision was created by SVN::Mirror (also used by SVK).
786The property contains a repository UUID and a revision. We want
787to make it look like we are mirroring the original URL, so
788introduce a helper function that returns the original identity
789URL and UUID, and use it when generating metadata in commit
790messages.
Eric Wong97ae0912007-02-11 15:21:24 -0800791
Eric Wong0dfaf0a2007-02-18 02:34:09 -0800792svn.useSvnsyncProps::
793svn-remote.<name>.useSvnsyncprops::
Eric Wonga81ed0b2007-02-18 02:10:51 -0800794 Similar to the useSvmProps option; this is for users
795 of the svnsync(1) command distributed with SVN 1.4.x and
796 later.
797
Eric Wong0dfaf0a2007-02-18 02:34:09 -0800798svn-remote.<name>.rewriteRoot::
Eric Wonga81ed0b2007-02-18 02:10:51 -0800799 This allows users to create repositories from alternate
Yann Dirson647ac702009-07-07 22:22:19 +0200800 URLs. For example, an administrator could run 'git svn' on the
Eric Wonga81ed0b2007-02-18 02:10:51 -0800801 server locally (accessing via file://) but wish to distribute
802 the repository with a public http:// or svn:// URL in the
803 metadata so users of it will see the public URL.
804
Jay Soffian3e18ce12010-01-23 03:30:00 -0500805svn-remote.<name>.rewriteUUID::
806 Similar to the useSvmProps option; this is for users who need
807 to remap the UUID manually. This may be useful in situations
808 where the original UUID is not available via either useSvmProps
809 or useSvnsyncProps.
810
Alejandro R. Sedeño12a296b2011-04-08 10:57:54 -0400811svn-remote.<name>.pushurl::
812
Tom Russelloae9f6312016-06-08 19:23:16 +0200813 Similar to Git's `remote.<name>.pushurl`, this key is designed
Alejandro R. Sedeño12a296b2011-04-08 10:57:54 -0400814 to be used in cases where 'url' points to an SVN repository
815 via a read-only transport, to provide an alternate read/write
816 transport. It is assumed that both keys point to the same
817 repository. Unlike 'commiturl', 'pushurl' is a base path. If
818 either 'commiturl' or 'pushurl' could be used, 'commiturl'
819 takes precedence.
820
Eric Wong4c58a712009-01-31 17:31:12 -0800821svn.brokenSymlinkWorkaround::
Yann Dirson6c32a7a2009-07-07 22:22:20 +0200822 This disables potentially expensive checks to workaround
823 broken symlinks checked into SVN by broken clients. Set this
824 option to "false" if you track a SVN repository with many
825 empty blobs that are not symlinks. This option may be changed
826 while 'git svn' is running and take effect on the next
827 revision fetched. If unset, 'git svn' assumes this option to
828 be "true".
Jan Krüger3b2bbe92008-06-20 00:41:42 +0200829
Dmitry Statyvka3713e222010-07-30 04:30:13 +0200830svn.pathnameencoding::
831 This instructs git svn to recode pathnames to a given encoding.
832 It can be used by windows users and by those who work in non-utf8
833 locales to avoid corrupted file names with non-ASCII characters.
834 Valid encodings are the ones supported by Perl's Encode module.
835
Michael Haggerty55f9d7a2011-04-01 12:26:00 +0200836svn-remote.<name>.automkdirs::
837 Normally, the "git svn clone" and "git svn rebase" commands
838 attempt to recreate empty directories that are in the
839 Subversion repository. If this option is set to "false", then
840 empty directories will only be created if the "git svn mkdirs"
841 command is run explicitly. If unset, 'git svn' assumes this
842 option to be "true".
843
Jay Soffian3e18ce12010-01-23 03:30:00 -0500844Since the noMetadata, rewriteRoot, rewriteUUID, useSvnsyncProps and useSvmProps
Yann Dirson647ac702009-07-07 22:22:19 +0200845options all affect the metadata generated and used by 'git svn'; they
Eric Wonga81ed0b2007-02-18 02:10:51 -0800846*must* be set in the configuration file before any history is imported
847and these settings should never be changed once they are set.
848
Jay Soffian3e18ce12010-01-23 03:30:00 -0500849Additionally, only one of these options can be used per svn-remote
850section because they affect the 'git-svn-id:' metadata line, except
851for rewriteRoot and rewriteUUID which can be used together.
Eric Wonge8f5d902006-10-11 14:53:35 -0700852
Eric Wong448c81b2006-03-03 01:20:09 -0800853
Sergey Vlasov112f6382007-03-01 22:41:17 +0300854BASIC EXAMPLES
855--------------
Eric Wong3397f9d2006-02-16 01:24:16 -0800856
Sebastian Leske92166fd2012-11-30 08:16:30 +0100857Tracking and contributing to the trunk of a Subversion-managed project
858(ignoring tags and branches):
Eric Wong3397f9d2006-02-16 01:24:16 -0800859
Eric Wong20b1d702006-04-01 18:25:03 -0800860------------------------------------------------------------------------
Eric Wonga81ed0b2007-02-18 02:10:51 -0800861# Clone a repo (like git clone):
Michael Prokop2670ddc2008-09-30 01:01:34 +0200862 git svn clone http://svn.example.com/project/trunk
Eric Wonga81ed0b2007-02-18 02:10:51 -0800863# Enter the newly cloned directory:
864 cd trunk
Yann Dirson647ac702009-07-07 22:22:19 +0200865# You should be on master branch, double-check with 'git branch'
Eric Wonga81ed0b2007-02-18 02:10:51 -0800866 git branch
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100867# Do some work and commit locally to Git:
Eric Wonga81ed0b2007-02-18 02:10:51 -0800868 git commit ...
869# Something is committed to SVN, rebase your local changes against the
870# latest changes in SVN:
Jonathan Niederb1889c32008-06-30 01:09:04 -0500871 git svn rebase
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100872# Now commit your changes (that were committed previously using Git) to SVN,
Eric Wonga81ed0b2007-02-18 02:10:51 -0800873# as well as automatically updating your working HEAD:
Jonathan Niederb1889c32008-06-30 01:09:04 -0500874 git svn dcommit
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100875# Append svn:ignore settings to the default Git exclude file:
Jonathan Niederb1889c32008-06-30 01:09:04 -0500876 git svn show-ignore >> .git/info/exclude
Eric Wong20b1d702006-04-01 18:25:03 -0800877------------------------------------------------------------------------
Eric Wong3397f9d2006-02-16 01:24:16 -0800878
Eric Wong0d313b22007-01-04 18:04:06 -0800879Tracking and contributing to an entire Subversion-managed project
880(complete with a trunk, tags and branches):
Eric Wong0d313b22007-01-04 18:04:06 -0800881
882------------------------------------------------------------------------
Sebastian Leske92166fd2012-11-30 08:16:30 +0100883# Clone a repo with standard SVN directory layout (like git clone):
Johan Herland7091a2d2013-10-11 14:57:05 +0200884 git svn clone http://svn.example.com/project --stdlayout --prefix svn/
Sebastian Leske92166fd2012-11-30 08:16:30 +0100885# Or, if the repo uses a non-standard directory layout:
Johan Herland7091a2d2013-10-11 14:57:05 +0200886 git svn clone http://svn.example.com/project -T tr -b branch -t tag --prefix svn/
Eric Wonga81ed0b2007-02-18 02:10:51 -0800887# View all branches and tags you have cloned:
888 git branch -r
Florian Ragwitz5de70ef2008-10-04 19:35:17 -0700889# Create a new branch in SVN
Stefan Beller3c123fb2013-10-21 21:36:06 +0200890 git svn branch waldo
Eric Wonga81ed0b2007-02-18 02:10:51 -0800891# Reset your master to trunk (or any other branch, replacing 'trunk'
892# with the appropriate name):
Johan Herland7091a2d2013-10-11 14:57:05 +0200893 git reset --hard svn/trunk
Eric Wonga81ed0b2007-02-18 02:10:51 -0800894# You may only dcommit to one branch/tag/trunk at a time. The usage
Michael Coleman20f50f12007-02-28 23:14:23 -0600895# of dcommit/rebase/show-ignore should be the same as above.
Eric Wong0d313b22007-01-04 18:04:06 -0800896------------------------------------------------------------------------
897
Yann Dirson647ac702009-07-07 22:22:19 +0200898The initial 'git svn clone' can be quite time-consuming
Adam Roben7d4aef42007-08-06 01:16:43 -0700899(especially for large Subversion repositories). If multiple
900people (or one person with multiple machines) want to use
Yann Dirson647ac702009-07-07 22:22:19 +0200901'git svn' to interact with the same Subversion repository, you can
902do the initial 'git svn clone' to a repository on a server and
903have each person clone that repository with 'git clone':
Adam Roben7d4aef42007-08-06 01:16:43 -0700904
905------------------------------------------------------------------------
906# Do the initial import on a server
Johan Herland7091a2d2013-10-11 14:57:05 +0200907 ssh server "cd /pub && git svn clone http://svn.example.com/project [options...]"
Sam Vilain2b0d1032008-01-25 12:10:02 +1300908# Clone locally - make sure the refs/remotes/ space matches the server
909 mkdir project
910 cd project
Jonathan Niederb1889c32008-06-30 01:09:04 -0500911 git init
Sam Vilain2b0d1032008-01-25 12:10:02 +1300912 git remote add origin server:/pub/project
StephenB9cfdbf92011-01-06 19:06:51 +0000913 git config --replace-all remote.origin.fetch '+refs/remotes/*:refs/remotes/*'
Sam Vilain2b0d1032008-01-25 12:10:02 +1300914 git fetch
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100915# Prevent fetch/pull from remote Git server in the future,
StephenB9cfdbf92011-01-06 19:06:51 +0000916# we only want to use git svn for future updates
917 git config --remove-section remote.origin
Jan Krüger9e773532008-11-14 18:45:14 +0100918# Create a local branch from one of the branches just fetched
919 git checkout -b master FETCH_HEAD
Johan Herland7091a2d2013-10-11 14:57:05 +0200920# Initialize 'git svn' locally (be sure to use the same URL and
921# --stdlayout/-T/-b/-t/--prefix options as were used on server)
922 git svn init http://svn.example.com/project [options...]
Adam Roben7d4aef42007-08-06 01:16:43 -0700923# Pull the latest changes from Subversion
Jonathan Niederb1889c32008-06-30 01:09:04 -0500924 git svn rebase
Adam Roben7d4aef42007-08-06 01:16:43 -0700925------------------------------------------------------------------------
926
Eric Wong2eff1422007-01-06 17:53:40 -0800927REBASE VS. PULL/MERGE
928---------------------
Jon Seymour2b26b65f2012-05-17 13:20:43 +1000929Prefer to use 'git svn rebase' or 'git rebase', rather than
930'git pull' or 'git merge' to synchronize unintegrated commits with a 'git svn'
931branch. Doing so will keep the history of unintegrated commits linear with
932respect to the upstream SVN repository and allow the use of the preferred
933'git svn dcommit' subcommand to push unintegrated commits back into SVN.
Eric Wong2e931152006-08-25 12:48:23 -0700934
Jon Seymour2b26b65f2012-05-17 13:20:43 +1000935Originally, 'git svn' recommended that developers pulled or merged from
936the 'git svn' branch. This was because the author favored
Jonathan Nieder483bc4f2008-06-30 13:56:34 -0500937`git svn set-tree B` to commit a single head rather than the
Jon Seymour2b26b65f2012-05-17 13:20:43 +1000938`git svn set-tree A..B` notation to commit multiple commits. Use of
939'git pull' or 'git merge' with `git svn set-tree A..B` will cause non-linear
940history to be flattened when committing into SVN and this can lead to merge
941commits unexpectedly reversing previous commits in SVN.
Eric Wong2e931152006-08-25 12:48:23 -0700942
Stefan Sperlingfd91d262011-04-19 11:06:46 +0200943MERGE TRACKING
944--------------
945While 'git svn' can track
Eric Wongbd430982007-09-18 16:50:42 -0700946copy history (including branches and tags) for repositories adopting a
947standard layout, it cannot yet represent merge history that happened
948inside git back upstream to SVN users. Therefore it is advised that
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100949users keep history as linear as possible inside Git to ease
Eric Wongbd430982007-09-18 16:50:42 -0700950compatibility with SVN (see the CAVEATS section below).
Eric Wong1d52aba2006-03-09 03:48:47 -0800951
Sebastian Leske7cad29d2012-11-30 08:16:30 +0100952HANDLING OF SVN BRANCHES
953------------------------
954If 'git svn' is configured to fetch branches (and --follow-branches
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100955is in effect), it sometimes creates multiple Git branches for one
Stefano Lattarinie1c3bf42013-04-12 00:36:10 +0200956SVN branch, where the additional branches have names of the form
Sebastian Leske7cad29d2012-11-30 08:16:30 +0100957'branchname@nnn' (with nnn an SVN revision number). These additional
958branches are created if 'git svn' cannot find a parent commit for the
959first commit in an SVN branch, to connect the branch to the history of
960the other branches.
961
962Normally, the first commit in an SVN branch consists
963of a copy operation. 'git svn' will read this commit to get the SVN
964revision the branch was created from. It will then try to find the
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100965Git commit that corresponds to this SVN revision, and use that as the
Sebastian Leske7cad29d2012-11-30 08:16:30 +0100966parent of the branch. However, it is possible that there is no suitable
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100967Git commit to serve as parent. This will happen, among other reasons,
Sebastian Leske7cad29d2012-11-30 08:16:30 +0100968if the SVN branch is a copy of a revision that was not fetched by 'git
969svn' (e.g. because it is an old revision that was skipped with
Matthieu Moybcf96262016-06-28 13:40:11 +0200970`--revision`), or if in SVN a directory was copied that is not tracked
Sebastian Leske7cad29d2012-11-30 08:16:30 +0100971by 'git svn' (such as a branch that is not tracked at all, or a
972subdirectory of a tracked branch). In these cases, 'git svn' will still
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100973create a Git branch, but instead of using an existing Git commit as the
Sebastian Leske7cad29d2012-11-30 08:16:30 +0100974parent of the branch, it will read the SVN history of the directory the
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100975branch was copied from and create appropriate Git commits. This is
Sebastian Leske7cad29d2012-11-30 08:16:30 +0100976indicated by the message "Initializing parent: <branchname>".
977
978Additionally, it will create a special branch named
979'<branchname>@<SVN-Revision>', where <SVN-Revision> is the SVN revision
980number the branch was copied from. This branch will point to the newly
981created parent commit of the branch. If in SVN the branch was deleted
982and later recreated from a different version, there will be multiple
983such branches with an '@'.
984
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100985Note that this may mean that multiple Git commits are created for a
Sebastian Leske7cad29d2012-11-30 08:16:30 +0100986single SVN revision.
987
988An example: in an SVN repository with a standard
989trunk/tags/branches layout, a directory trunk/sub is created in r.100.
990In r.200, trunk/sub is branched by copying it to branches/. 'git svn
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100991clone -s' will then create a branch 'sub'. It will also create new Git
Sebastian Leske7cad29d2012-11-30 08:16:30 +0100992commits for r.100 through r.199 and use these as the history of branch
Thomas Ackermann2de9b712013-01-21 20:17:53 +0100993'sub'. Thus there will be two Git commits for each revision from r.100
Sebastian Leske7cad29d2012-11-30 08:16:30 +0100994to r.199 (one containing trunk/, one containing trunk/sub/). Finally,
995it will create a branch 'sub@200' pointing to the new parent commit of
996branch 'sub' (i.e. the commit for r.200 and trunk/sub/).
997
Eric Wongaabb2e52007-08-16 01:56:45 -0700998CAVEATS
999-------
1000
Stefan Sperlingfd91d262011-04-19 11:06:46 +02001001For the sake of simplicity and interoperating with Subversion,
1002it is recommended that all 'git svn' users clone, fetch and dcommit
Yann Dirson647ac702009-07-07 22:22:19 +02001003directly from the SVN server, and avoid all 'git clone'/'pull'/'merge'/'push'
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001004operations between Git repositories and branches. The recommended
1005method of exchanging code between Git branches and users is
Yann Dirson647ac702009-07-07 22:22:19 +02001006'git format-patch' and 'git am', or just 'dcommit'ing to the SVN repository.
Eric Wongaabb2e52007-08-16 01:56:45 -07001007
Yann Dirson647ac702009-07-07 22:22:19 +02001008Running 'git merge' or 'git pull' is NOT recommended on a branch you
Stefan Sperlingfd91d262011-04-19 11:06:46 +02001009plan to 'dcommit' from because Subversion users cannot see any
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001010merges you've made. Furthermore, if you merge or pull from a Git branch
Jonathan Nieder483bc4f2008-06-30 13:56:34 -05001011that is a mirror of an SVN branch, 'dcommit' may commit to the wrong
Eric Wongaabb2e52007-08-16 01:56:45 -07001012branch.
1013
Thomas Rastce45a452009-11-16 11:15:17 +01001014If you do merge, note the following rule: 'git svn dcommit' will
1015attempt to commit on top of the SVN commit named in
1016------------------------------------------------------------------------
1017git log --grep=^git-svn-id: --first-parent -1
1018------------------------------------------------------------------------
1019You 'must' therefore ensure that the most recent commit of the branch
1020you want to dcommit to is the 'first' parent of the merge. Chaos will
1021ensue otherwise, especially if the first parent is an older commit on
1022the same SVN branch.
1023
Yann Dirson647ac702009-07-07 22:22:19 +02001024'git clone' does not clone branches under the refs/remotes/ hierarchy or
1025any 'git svn' metadata, or config. So repositories created and managed with
1026using 'git svn' should use 'rsync' for cloning, if cloning is to be done
Eric Wongaabb2e52007-08-16 01:56:45 -07001027at all.
1028
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001029Since 'dcommit' uses rebase internally, any Git branches you 'git push' to
Jonathan Nieder483bc4f2008-06-30 13:56:34 -05001030before 'dcommit' on will require forcing an overwrite of the existing ref
Eric Wongaabb2e52007-08-16 01:56:45 -07001031on the remote repository. This is generally considered bad practice,
Jonathan Nieder483bc4f2008-06-30 13:56:34 -05001032see the linkgit:git-push[1] documentation for details.
Eric Wongaabb2e52007-08-16 01:56:45 -07001033
Jonathan Nieder483bc4f2008-06-30 13:56:34 -05001034Do not use the --amend option of linkgit:git-commit[1] on a change you've
Eric Wongaabb2e52007-08-16 01:56:45 -07001035already dcommitted. It is considered bad practice to --amend commits
1036you've already pushed to a remote repository for other users, and
1037dcommit with SVN is analogous to that.
1038
Sebastian Leske92166fd2012-11-30 08:16:30 +01001039When cloning an SVN repository, if none of the options for describing
1040the repository layout is used (--trunk, --tags, --branches,
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001041--stdlayout), 'git svn clone' will create a Git repository with
Sebastian Leske92166fd2012-11-30 08:16:30 +01001042completely linear history, where branches and tags appear as separate
1043directories in the working copy. While this is the easiest way to get a
1044copy of a complete repository, for projects with many branches it will
1045lead to a working copy many times larger than just the trunk. Thus for
1046projects using the standard directory structure (trunk/branches/tags),
Matthieu Moybcf96262016-06-28 13:40:11 +02001047it is recommended to clone with option `--stdlayout`. If the project
Sebastian Leske92166fd2012-11-30 08:16:30 +01001048uses a non-standard structure, and/or if branches and tags are not
1049required, it is easiest to only clone one directory (typically trunk),
1050without giving any repository layout options. If the full history with
Matthieu Moybcf96262016-06-28 13:40:11 +02001051branches and tags is required, the options `--trunk` / `--branches` /
1052`--tags` must be used.
Sebastian Leske92166fd2012-11-30 08:16:30 +01001053
Yann Dirson647ac702009-07-07 22:22:19 +02001054When using multiple --branches or --tags, 'git svn' does not automatically
Marc Branchaudab81a362009-06-26 16:49:19 -04001055handle name collisions (for example, if two branches from different paths have
1056the same name, or if a branch and a tag have the same name). In these cases,
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001057use 'init' to set up your Git repository then, before your first 'fetch', edit
Keshav Kini6fe7a302013-09-29 18:45:59 -05001058the $GIT_DIR/config file so that the branches and tags are associated
1059with different name spaces. For example:
Marc Branchaudab81a362009-06-26 16:49:19 -04001060
1061 branches = stable/*:refs/remotes/svn/stable/*
1062 branches = debug/*:refs/remotes/svn/debug/*
1063
Eric Wong3397f9d2006-02-16 01:24:16 -08001064BUGS
1065----
Eric Wonge8f5d902006-10-11 14:53:35 -07001066
Eric Wonga81ed0b2007-02-18 02:10:51 -08001067We ignore all SVN properties except svn:executable. Any unhandled
1068properties are logged to $GIT_DIR/svn/<refname>/unhandled.log
Eric Wong3397f9d2006-02-16 01:24:16 -08001069
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001070Renamed and copied directories are not detected by Git and hence not
Eric Wongbbe0c9b2006-02-20 10:57:28 -08001071tracked when committing to SVN. I do not plan on adding support for
1072this as it's quite difficult and time-consuming to get working for all
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001073the possible corner cases (Git doesn't do it, either). Committing
Stefan Sperlingfd91d262011-04-19 11:06:46 +02001074renamed and copied files is fully supported if they're similar enough
Thomas Ackermann2de9b712013-01-21 20:17:53 +01001075for Git to detect them.
Eric Wongbbe0c9b2006-02-20 10:57:28 -08001076
Sebastian Leskedd465ce2012-11-23 08:29:38 +01001077In SVN, it is possible (though discouraged) to commit changes to a tag
1078(because a tag is just a directory copy, thus technically the same as a
1079branch). When cloning an SVN repository, 'git svn' cannot know if such a
1080commit to a tag will happen in the future. Thus it acts conservatively
1081and imports all SVN tags as branches, prefixing the tag name with 'tags/'.
1082
Eric Wonga836a0e2007-02-14 19:34:56 -08001083CONFIGURATION
1084-------------
1085
Yann Dirson647ac702009-07-07 22:22:19 +02001086'git svn' stores [svn-remote] configuration information in the
Keshav Kini6fe7a302013-09-29 18:45:59 -05001087repository $GIT_DIR/config file. It is similar the core Git
Eric Wonga836a0e2007-02-14 19:34:56 -08001088[remote] sections except 'fetch' keys do not accept glob
1089arguments; but they are instead handled by the 'branches'
1090and 'tags' keys. Since some SVN repositories are oddly
1091configured with multiple projects glob expansions such those
1092listed below are allowed:
1093
1094------------------------------------------------------------------------
1095[svn-remote "project-a"]
1096 url = http://server.org/svn
Wesley J. Landaker0e5e69a2009-04-01 16:05:01 -06001097 fetch = trunk/project-a:refs/remotes/project-a/trunk
Eric Wonga836a0e2007-02-14 19:34:56 -08001098 branches = branches/*/project-a:refs/remotes/project-a/branches/*
Victor Leschuke4e5dd92016-01-11 17:25:58 +03001099 branches = branches/release_*:refs/remotes/project-a/branches/release_*
1100 branches = branches/re*se:refs/remotes/project-a/branches/*
Eric Wonga836a0e2007-02-14 19:34:56 -08001101 tags = tags/*/project-a:refs/remotes/project-a/tags/*
Eric Wonga836a0e2007-02-14 19:34:56 -08001102------------------------------------------------------------------------
1103
Todd Zullinger9e4cbcc2019-04-09 20:37:34 -04001104Keep in mind that the `*` (asterisk) wildcard of the local ref
1105(right of the `:`) *must* be the farthest right path component;
Wesley J. Landakerbad542f2009-04-22 09:48:58 -06001106however the remote wildcard may be anywhere as long as it's an
Todd Zullinger9e4cbcc2019-04-09 20:37:34 -04001107independent path component (surrounded by `/` or EOL). This
Eric Wonga836a0e2007-02-14 19:34:56 -08001108type of configuration is not automatically created by 'init' and
Yann Dirson647ac702009-07-07 22:22:19 +02001109should be manually entered with a text-editor or using 'git config'.
Eric Wonga836a0e2007-02-14 19:34:56 -08001110
Victor Leschuke4e5dd92016-01-11 17:25:58 +03001111Also note that only one asterisk is allowed per word. For example:
1112
1113 branches = branches/re*se:refs/remotes/project-a/branches/*
1114
1115will match branches 'release', 'rese', 're123se', however
1116
1117 branches = branches/re*s*e:refs/remotes/project-a/branches/*
1118
1119will produce an error.
1120
Jay Soffian07576202010-01-23 03:30:01 -05001121It is also possible to fetch a subset of branches or tags by using a
1122comma-separated list of names within braces. For example:
1123
1124------------------------------------------------------------------------
1125[svn-remote "huge-project"]
1126 url = http://server.org/svn
1127 fetch = trunk/src:refs/remotes/trunk
Johan Herland7091a2d2013-10-11 14:57:05 +02001128 branches = branches/{red,green}/src:refs/remotes/project-a/branches/*
1129 tags = tags/{1.0,2.0}/src:refs/remotes/project-a/tags/*
Jay Soffian07576202010-01-23 03:30:01 -05001130------------------------------------------------------------------------
1131
Nathan Grayeff714b2011-12-19 19:23:50 -06001132Multiple fetch, branches, and tags keys are supported:
1133
1134------------------------------------------------------------------------
1135[svn-remote "messy-repo"]
1136 url = http://server.org/svn
1137 fetch = trunk/project-a:refs/remotes/project-a/trunk
1138 fetch = branches/demos/june-project-a-demo:refs/remotes/project-a/demos/june-demo
1139 branches = branches/server/*:refs/remotes/project-a/branches/*
1140 branches = branches/demos/2011/*:refs/remotes/project-a/2011-demos/*
1141 tags = tags/server/*:refs/remotes/project-a/tags/*
1142------------------------------------------------------------------------
1143
Jonathan Nieder7d82b4a2011-12-19 19:24:30 -06001144Creating a branch in such a configuration requires disambiguating which
1145location to use using the -d or --destination flag:
1146
1147------------------------------------------------------------------------
1148$ git svn branch -d branches/server release-2-3-0
1149------------------------------------------------------------------------
1150
Jay Soffian07576202010-01-23 03:30:01 -05001151Note that git-svn keeps track of the highest revision in which a branch
1152or tag has appeared. If the subset of branches or tags is changed after
Keshav Kini6fe7a302013-09-29 18:45:59 -05001153fetching, then $GIT_DIR/svn/.metadata must be manually edited to remove
1154(or reset) branches-maxRev and/or tags-maxRev as appropriate.
Jay Soffian07576202010-01-23 03:30:01 -05001155
Keshav Kini945b9c12013-09-29 18:46:00 -05001156FILES
1157-----
Martin Ågren4c8b8822019-03-06 07:30:17 +01001158$GIT_DIR/svn/\**/.rev_map.*::
Keshav Kini945b9c12013-09-29 18:46:00 -05001159 Mapping between Subversion revision numbers and Git commit
1160 names. In a repository where the noMetadata option is not set,
1161 this can be rebuilt from the git-svn-id: lines that are at the
1162 end of every commit (see the 'svn.noMetadata' section above for
1163 details).
1164+
1165'git svn fetch' and 'git svn rebase' automatically update the rev_map
1166if it is missing or not up to date. 'git svn reset' automatically
1167rewinds it.
1168
Eric Wong2e931152006-08-25 12:48:23 -07001169SEE ALSO
1170--------
Dan McGee5162e692007-12-29 00:20:38 -06001171linkgit:git-rebase[1]
Jeff King6ea922d2011-03-11 01:08:48 -05001172
1173GIT
1174---
1175Part of the linkgit:git[1] suite