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