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