]>
Commit | Line | Data |
---|---|---|
3397f9df EW |
1 | git-svn(1) |
2 | ========== | |
3 | ||
4 | NAME | |
5 | ---- | |
c3f0baac | 6 | git-svn - Bidirectional operation between a single Subversion branch and git |
3397f9df EW |
7 | |
8 | SYNOPSIS | |
9 | -------- | |
10 | 'git-svn' <command> [options] [arguments] | |
11 | ||
12 | DESCRIPTION | |
13 | ----------- | |
0d313b2b EW |
14 | git-svn is a simple conduit for changesets between Subversion and git. |
15 | It is not to be confused with gitlink:git-svnimport[1], which is | |
a836a0e1 | 16 | read-only. |
3397f9df | 17 | |
0d313b2b | 18 | git-svn was originally designed for an individual developer who wants a |
3397f9df | 19 | bidirectional flow of changesets between a single branch in Subversion |
0d313b2b EW |
20 | and an arbitrary number of branches in git. Since its inception, |
21 | git-svn has gained the ability to track multiple branches in a manner | |
a836a0e1 | 22 | similar to git-svnimport. |
3397f9df | 23 | |
0d313b2b EW |
24 | git-svn is especially useful when it comes to tracking repositories |
25 | not organized in the way Subversion developers recommend (trunk, | |
26 | branches, tags directories). | |
3397f9df EW |
27 | |
28 | COMMANDS | |
29 | -------- | |
0ea4d4c9 JF |
30 | -- |
31 | ||
32 | 'init':: | |
a836a0e1 EW |
33 | Initializes an empty git repository with additional |
34 | metadata directories for git-svn. The Subversion URL | |
35 | may be specified as a command-line argument, or as full | |
36 | URL arguments to -T/-t/-b. Optionally, the target | |
37 | directory to operate on can be specified as a second | |
38 | argument. Normally this command initializes the current | |
39 | directory. | |
3397f9df | 40 | |
cc1793e2 KW |
41 | -T<trunk_subdir>;; |
42 | --trunk=<trunk_subdir>;; | |
43 | -t<tags_subdir>;; | |
44 | --tags=<tags_subdir>;; | |
45 | -b<branches_subdir>;; | |
46 | --branches=<branches_subdir>;; | |
8f728fb9 | 47 | -s;; |
48 | --stdlayout;; | |
a836a0e1 EW |
49 | These are optional command-line options for init. Each of |
50 | these flags can point to a relative repository path | |
51 | (--tags=project/tags') or a full url | |
8f728fb9 | 52 | (--tags=https://foo.org/project/tags). The option --stdlayout is |
53 | a shorthand way of setting trunk,tags,branches as the relative paths, | |
54 | which is the Subversion default. If any of the other options are given | |
55 | as well, they take precedence. | |
cc1793e2 | 56 | --no-metadata;; |
0dfaf0a4 | 57 | Set the 'noMetadata' option in the [svn-remote] config. |
cc1793e2 | 58 | --use-svm-props;; |
0dfaf0a4 | 59 | Set the 'useSvmProps' option in the [svn-remote] config. |
cc1793e2 | 60 | --use-svnsync-props;; |
0dfaf0a4 | 61 | Set the 'useSvnsyncProps' option in the [svn-remote] config. |
cc1793e2 | 62 | --rewrite-root=<URL>;; |
0dfaf0a4 | 63 | Set the 'rewriteRoot' option in the [svn-remote] config. |
cc1793e2 | 64 | --username=<USER>;; |
a0d7fe3f SV |
65 | For transports that SVN handles authentication for (http, |
66 | https, and plain svn), specify the username. For other | |
67 | transports (eg svn+ssh://), you must include the username in | |
68 | the URL, eg svn+ssh://foo@svn.bar.com/project | |
cc1793e2 | 69 | --prefix=<prefix>;; |
a836a0e1 EW |
70 | This allows one to specify a prefix which is prepended |
71 | to the names of remotes if trunk/branches/tags are | |
72 | specified. The prefix does not automatically include a | |
73 | trailing slash, so be sure you include one in the | |
0d351e9c GP |
74 | argument if that is what you want. If --branches/-b is |
75 | specified, the prefix must include a trailing slash. | |
76 | Setting a prefix is useful if you wish to track multiple | |
77 | projects that share a common repository. | |
81c5a0e6 | 78 | |
a836a0e1 | 79 | 'fetch':: |
a836a0e1 EW |
80 | Fetch unfetched revisions from the Subversion remote we are |
81 | tracking. The name of the [svn-remote "..."] section in the | |
82 | .git/config file may be specified as an optional command-line | |
83 | argument. | |
b705ba43 | 84 | |
a81ed0b6 EW |
85 | 'clone':: |
86 | Runs 'init' and 'fetch'. It will automatically create a | |
87 | directory based on the basename of the URL passed to it; | |
88 | or if a second argument is passed; it will create a directory | |
89 | and work within that. It accepts all arguments that the | |
90 | 'init' and 'fetch' commands accept; with the exception of | |
91 | '--fetch-all'. After a repository is cloned, the 'fetch' | |
92 | command will be able to update revisions without affecting | |
93 | the working tree; and the 'rebase' command will be able | |
94 | to update the working tree with the latest changes. | |
95 | ||
96 | 'rebase':: | |
97 | This fetches revisions from the SVN parent of the current HEAD | |
98 | and rebases the current (uncommitted to SVN) work against it. | |
99 | ||
112f6385 SV |
100 | This works similarly to 'svn update' or 'git-pull' except that |
101 | it preserves linear history with 'git-rebase' instead of | |
02783075 | 102 | 'git-merge' for ease of dcommiting with git-svn. |
a81ed0b6 | 103 | |
112f6385 SV |
104 | This accepts all options that 'git-svn fetch' and 'git-rebase' |
105 | accepts. However '--fetch-all' only fetches from the current | |
106 | [svn-remote], and not all [svn-remote] definitions. | |
a81ed0b6 | 107 | |
112f6385 SV |
108 | Like 'git-rebase'; this requires that the working tree be clean |
109 | and have no uncommitted changes. | |
cc1793e2 | 110 | |
dee41f3e EW |
111 | -l;; |
112 | --local;; | |
113 | Do not fetch remotely; only run 'git-rebase' against the | |
114 | last fetched commit from the upstream SVN. | |
a81ed0b6 | 115 | |
b22d4497 | 116 | 'dcommit':: |
2eff1425 | 117 | Commit each diff from a specified head directly to the SVN |
b22d4497 | 118 | repository, and then rebase or reset (depending on whether or |
2eff1425 EW |
119 | not there is a diff between SVN and head). This will create |
120 | a revision in SVN for each commit in git. | |
121 | It is recommended that you run git-svn fetch and rebase (not | |
122 | pull or merge) your commits against the latest changes in the | |
123 | SVN repository. | |
dd31da2f EW |
124 | An optional command-line argument may be specified as an |
125 | alternative to HEAD. | |
3289e86e | 126 | This is advantageous over 'set-tree' (below) because it produces |
b22d4497 | 127 | cleaner, more linear history. |
171af110 KW |
128 | + |
129 | --no-rebase;; | |
130 | After committing, do not rebase or reset. | |
112f6385 | 131 | -- |
b22d4497 | 132 | |
e8f5d908 EW |
133 | 'log':: |
134 | This should make it easy to look up svn log messages when svn | |
135 | users refer to -r/--revision numbers. | |
112f6385 SV |
136 | + |
137 | The following features from `svn log' are supported: | |
138 | + | |
139 | -- | |
140 | --revision=<n>[:<n>];; | |
141 | is supported, non-numeric args are not: | |
142 | HEAD, NEXT, BASE, PREV, etc ... | |
143 | -v/--verbose;; | |
144 | it's not completely compatible with the --verbose | |
145 | output in svn log, but reasonably close. | |
146 | --limit=<n>;; | |
147 | is NOT the same as --max-count, doesn't count | |
148 | merged/excluded commits | |
149 | --incremental;; | |
150 | supported | |
151 | -- | |
152 | + | |
153 | New features: | |
154 | + | |
155 | -- | |
156 | --show-commit;; | |
157 | shows the git commit sha1, as well | |
158 | --oneline;; | |
159 | our version of --pretty=oneline | |
160 | -- | |
161 | + | |
162 | Any other arguments are passed directly to `git log' | |
e8f5d908 | 163 | |
112f6385 | 164 | -- |
26e60160 AR |
165 | 'find-rev':: |
166 | When given an SVN revision number of the form 'rN', returns the | |
b3cb7e45 AR |
167 | corresponding git commit hash (this can optionally be followed by a |
168 | tree-ish to specify which branch should be searched). When given a | |
169 | tree-ish, returns the corresponding SVN revision number. | |
26e60160 | 170 | |
3289e86e | 171 | 'set-tree':: |
e8f5d908 | 172 | You should consider using 'dcommit' instead of this command. |
3397f9df EW |
173 | Commit specified commit or tree objects to SVN. This relies on |
174 | your imported fetch data being up-to-date. This makes | |
175 | absolutely no attempts to do patching when committing to SVN, it | |
176 | simply overwrites files with those specified in the tree or | |
177 | commit. All merging is assumed to have taken place | |
178 | independently of git-svn functions. | |
179 | ||
0ea4d4c9 | 180 | 'show-ignore':: |
8f22562c EW |
181 | Recursively finds and lists the svn:ignore property on |
182 | directories. The output is suitable for appending to | |
183 | the $GIT_DIR/info/exclude file. | |
184 | ||
e8f5d908 EW |
185 | 'commit-diff':: |
186 | Commits the diff of two tree-ish arguments from the | |
23bfbb81 | 187 | command-line. This command is intended for interoperability with |
e8f5d908 EW |
188 | git-svnimport and does not rely on being inside an git-svn |
189 | init-ed repository. This command takes three arguments, (a) the | |
190 | original tree to diff against, (b) the new tree result, (c) the | |
191 | URL of the target Subversion repository. The final argument | |
192 | (URL) may be omitted if you are working from a git-svn-aware | |
193 | repository (that has been init-ed with git-svn). | |
45bf473a | 194 | The -r<revision> option is required for this. |
e8f5d908 | 195 | |
e6fefa92 DK |
196 | 'info':: |
197 | Shows information about a file or directory similar to what | |
198 | `svn info' provides. Does not currently support a -r/--revision | |
199 | argument. | |
200 | ||
0ea4d4c9 JF |
201 | -- |
202 | ||
3397f9df EW |
203 | OPTIONS |
204 | ------- | |
0ea4d4c9 JF |
205 | -- |
206 | ||
a836a0e1 | 207 | --shared[={false|true|umask|group|all|world|everybody}]:: |
e8f5d908 EW |
208 | --template=<template_directory>:: |
209 | Only used with the 'init' command. | |
5c94f87e | 210 | These are passed directly to gitlink:git-init[1]. |
e8f5d908 | 211 | |
3397f9df EW |
212 | -r <ARG>:: |
213 | --revision <ARG>:: | |
3397f9df | 214 | |
a836a0e1 | 215 | Used with the 'fetch' command. |
0ea4d4c9 | 216 | |
a836a0e1 EW |
217 | This allows revision ranges for partial/cauterized history |
218 | to be supported. $NUMBER, $NUMBER1:$NUMBER2 (numeric ranges), | |
219 | $NUMBER:HEAD, and BASE:$NUMBER are all supported. | |
3397f9df | 220 | |
a836a0e1 EW |
221 | This can allow you to make partial mirrors when running fetch; |
222 | but is generally not recommended because history will be skipped | |
223 | and lost. | |
3397f9df EW |
224 | |
225 | -:: | |
226 | --stdin:: | |
3397f9df | 227 | |
3289e86e | 228 | Only used with the 'set-tree' command. |
0ea4d4c9 JF |
229 | |
230 | Read a list of commits from stdin and commit them in reverse | |
231 | order. Only the leading sha1 is read from each line, so | |
232 | git-rev-list --pretty=oneline output can be used. | |
3397f9df EW |
233 | |
234 | --rmdir:: | |
3397f9df | 235 | |
3289e86e | 236 | Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands. |
0ea4d4c9 JF |
237 | |
238 | Remove directories from the SVN tree if there are no files left | |
239 | behind. SVN can version empty directories, and they are not | |
240 | removed by default if there are no files left in them. git | |
241 | cannot version empty directories. Enabling this flag will make | |
242 | the commit to SVN act like git. | |
3397f9df | 243 | |
e0d10e1c | 244 | config key: svn.rmdir |
20b1d700 | 245 | |
3397f9df EW |
246 | -e:: |
247 | --edit:: | |
3397f9df | 248 | |
3289e86e | 249 | Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands. |
3397f9df | 250 | |
0ea4d4c9 JF |
251 | Edit the commit message before committing to SVN. This is off by |
252 | default for objects that are commits, and forced on when committing | |
253 | tree objects. | |
254 | ||
e0d10e1c | 255 | config key: svn.edit |
20b1d700 | 256 | |
72942938 EW |
257 | -l<num>:: |
258 | --find-copies-harder:: | |
72942938 | 259 | |
3289e86e | 260 | Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands. |
0ea4d4c9 JF |
261 | |
262 | They are both passed directly to git-diff-tree see | |
263 | gitlink:git-diff-tree[1] for more information. | |
72942938 | 264 | |
0ea4d4c9 | 265 | [verse] |
e0d10e1c TP |
266 | config key: svn.l |
267 | config key: svn.findcopiesharder | |
20b1d700 | 268 | |
81c5a0e6 EW |
269 | -A<filename>:: |
270 | --authors-file=<filename>:: | |
271 | ||
0ea4d4c9 JF |
272 | Syntax is compatible with the files used by git-svnimport and |
273 | git-cvsimport: | |
81c5a0e6 EW |
274 | |
275 | ------------------------------------------------------------------------ | |
0ea4d4c9 | 276 | loginname = Joe User <user@example.com> |
81c5a0e6 EW |
277 | ------------------------------------------------------------------------ |
278 | ||
0ea4d4c9 JF |
279 | If this option is specified and git-svn encounters an SVN |
280 | committer name that does not exist in the authors-file, git-svn | |
281 | will abort operation. The user will then have to add the | |
282 | appropriate entry. Re-running the previous git-svn command | |
283 | after the authors-file is modified should continue operation. | |
81c5a0e6 | 284 | |
e0d10e1c | 285 | config key: svn.authorsfile |
e8f5d908 EW |
286 | |
287 | -q:: | |
288 | --quiet:: | |
cec21ca7 | 289 | Make git-svn less verbose. |
e8f5d908 EW |
290 | |
291 | --repack[=<n>]:: | |
112f6385 SV |
292 | --repack-flags=<flags>:: |
293 | ||
294 | These should help keep disk usage sane for large fetches | |
295 | with many revisions. | |
e8f5d908 | 296 | |
112f6385 SV |
297 | --repack takes an optional argument for the number of revisions |
298 | to fetch before repacking. This defaults to repacking every | |
299 | 1000 commits fetched if no argument is specified. | |
e8f5d908 | 300 | |
112f6385 | 301 | --repack-flags are passed directly to gitlink:git-repack[1]. |
e8f5d908 | 302 | |
112f6385 | 303 | [verse] |
e0d10e1c TP |
304 | config key: svn.repack |
305 | config key: svn.repackflags | |
0ea4d4c9 | 306 | |
b22d4497 EW |
307 | -m:: |
308 | --merge:: | |
309 | -s<strategy>:: | |
310 | --strategy=<strategy>:: | |
311 | ||
a81ed0b6 | 312 | These are only used with the 'dcommit' and 'rebase' commands. |
b22d4497 EW |
313 | |
314 | Passed directly to git-rebase when using 'dcommit' if a | |
315 | 'git-reset' cannot be used (see dcommit). | |
316 | ||
317 | -n:: | |
318 | --dry-run:: | |
319 | ||
320 | This is only used with the 'dcommit' command. | |
321 | ||
322 | Print out the series of git arguments that would show | |
323 | which diffs would be committed to SVN. | |
324 | ||
0ea4d4c9 | 325 | -- |
81c5a0e6 | 326 | |
448c81b4 EW |
327 | ADVANCED OPTIONS |
328 | ---------------- | |
0ea4d4c9 JF |
329 | -- |
330 | ||
448c81b4 EW |
331 | -i<GIT_SVN_ID>:: |
332 | --id <GIT_SVN_ID>:: | |
0ea4d4c9 | 333 | |
a836a0e1 EW |
334 | This sets GIT_SVN_ID (instead of using the environment). This |
335 | allows the user to override the default refname to fetch from | |
336 | when tracking a single URL. The 'log' and 'dcommit' commands | |
337 | no longer require this switch as an argument. | |
0ea4d4c9 | 338 | |
9760adcc EW |
339 | -R<remote name>:: |
340 | --svn-remote <remote name>:: | |
341 | Specify the [svn-remote "<remote name>"] section to use, | |
a836a0e1 EW |
342 | this allows SVN multiple repositories to be tracked. |
343 | Default: "svn" | |
9760adcc | 344 | |
e8f5d908 EW |
345 | --follow-parent:: |
346 | This is especially helpful when we're tracking a directory | |
347 | that has been moved around within the repository, or if we | |
348 | started tracking a branch and never tracked the trunk it was | |
0bed5eaa EW |
349 | descended from. This feature is enabled by default, use |
350 | --no-follow-parent to disable it. | |
e8f5d908 | 351 | |
e0d10e1c | 352 | config key: svn.followparent |
e8f5d908 | 353 | |
a81ed0b6 EW |
354 | -- |
355 | CONFIG FILE-ONLY OPTIONS | |
356 | ------------------------ | |
357 | -- | |
358 | ||
0dfaf0a4 EW |
359 | svn.noMetadata:: |
360 | svn-remote.<name>.noMetadata:: | |
e8f5d908 | 361 | |
112f6385 SV |
362 | This gets rid of the git-svn-id: lines at the end of every commit. |
363 | ||
364 | If you lose your .git/svn/git-svn/.rev_db file, git-svn will not | |
365 | be able to rebuild it and you won't be able to fetch again, | |
366 | either. This is fine for one-shot imports. | |
e8f5d908 | 367 | |
112f6385 SV |
368 | The 'git-svn log' command will not work on repositories using |
369 | this, either. Using this conflicts with the 'useSvmProps' | |
370 | option for (hopefully) obvious reasons. | |
97ae0911 | 371 | |
0dfaf0a4 EW |
372 | svn.useSvmProps:: |
373 | svn-remote.<name>.useSvmProps:: | |
97ae0911 | 374 | |
112f6385 SV |
375 | This allows git-svn to re-map repository URLs and UUIDs from |
376 | mirrors created using SVN::Mirror (or svk) for metadata. | |
377 | ||
378 | If an SVN revision has a property, "svm:headrev", it is likely | |
379 | that the revision was created by SVN::Mirror (also used by SVK). | |
380 | The property contains a repository UUID and a revision. We want | |
381 | to make it look like we are mirroring the original URL, so | |
382 | introduce a helper function that returns the original identity | |
383 | URL and UUID, and use it when generating metadata in commit | |
384 | messages. | |
97ae0911 | 385 | |
0dfaf0a4 EW |
386 | svn.useSvnsyncProps:: |
387 | svn-remote.<name>.useSvnsyncprops:: | |
a81ed0b6 EW |
388 | Similar to the useSvmProps option; this is for users |
389 | of the svnsync(1) command distributed with SVN 1.4.x and | |
390 | later. | |
391 | ||
0dfaf0a4 | 392 | svn-remote.<name>.rewriteRoot:: |
a81ed0b6 EW |
393 | This allows users to create repositories from alternate |
394 | URLs. For example, an administrator could run git-svn on the | |
395 | server locally (accessing via file://) but wish to distribute | |
396 | the repository with a public http:// or svn:// URL in the | |
397 | metadata so users of it will see the public URL. | |
398 | ||
a81ed0b6 EW |
399 | Since the noMetadata, rewriteRoot, useSvnsyncProps and useSvmProps |
400 | options all affect the metadata generated and used by git-svn; they | |
401 | *must* be set in the configuration file before any history is imported | |
402 | and these settings should never be changed once they are set. | |
403 | ||
404 | Additionally, only one of these four options can be used per-svn-remote | |
405 | section because they affect the 'git-svn-id:' metadata line. | |
e8f5d908 | 406 | |
0ea4d4c9 | 407 | -- |
448c81b4 | 408 | |
112f6385 SV |
409 | BASIC EXAMPLES |
410 | -------------- | |
3397f9df | 411 | |
06ada152 | 412 | Tracking and contributing to the trunk of a Subversion-managed project: |
3397f9df | 413 | |
20b1d700 | 414 | ------------------------------------------------------------------------ |
a81ed0b6 EW |
415 | # Clone a repo (like git clone): |
416 | git-svn clone http://svn.foo.org/project/trunk | |
417 | # Enter the newly cloned directory: | |
418 | cd trunk | |
419 | # You should be on master branch, double-check with git-branch | |
420 | git branch | |
421 | # Do some work and commit locally to git: | |
422 | git commit ... | |
423 | # Something is committed to SVN, rebase your local changes against the | |
424 | # latest changes in SVN: | |
425 | git-svn rebase | |
426 | # Now commit your changes (that were committed previously using git) to SVN, | |
427 | # as well as automatically updating your working HEAD: | |
4511c899 | 428 | git-svn dcommit |
20b1d700 | 429 | # Append svn:ignore settings to the default git exclude file: |
8f22562c | 430 | git-svn show-ignore >> .git/info/exclude |
20b1d700 | 431 | ------------------------------------------------------------------------ |
3397f9df | 432 | |
0d313b2b EW |
433 | Tracking and contributing to an entire Subversion-managed project |
434 | (complete with a trunk, tags and branches): | |
0d313b2b EW |
435 | |
436 | ------------------------------------------------------------------------ | |
a81ed0b6 EW |
437 | # Clone a repo (like git clone): |
438 | git-svn clone http://svn.foo.org/project -T trunk -b branches -t tags | |
439 | # View all branches and tags you have cloned: | |
440 | git branch -r | |
441 | # Reset your master to trunk (or any other branch, replacing 'trunk' | |
442 | # with the appropriate name): | |
443 | git reset --hard remotes/trunk | |
444 | # You may only dcommit to one branch/tag/trunk at a time. The usage | |
20f50f16 | 445 | # of dcommit/rebase/show-ignore should be the same as above. |
0d313b2b EW |
446 | ------------------------------------------------------------------------ |
447 | ||
7d4aef40 AR |
448 | The initial 'git-svn clone' can be quite time-consuming |
449 | (especially for large Subversion repositories). If multiple | |
450 | people (or one person with multiple machines) want to use | |
451 | git-svn to interact with the same Subversion repository, you can | |
452 | do the initial 'git-svn clone' to a repository on a server and | |
453 | have each person clone that repository with 'git clone': | |
454 | ||
455 | ------------------------------------------------------------------------ | |
456 | # Do the initial import on a server | |
457 | ssh server "cd /pub && git-svn clone http://svn.foo.org/project | |
458 | # Clone locally | |
459 | git clone server:/pub/project | |
460 | # Tell git-svn which branch contains the Subversion commits | |
461 | git update-ref refs/remotes/git-svn origin/master | |
462 | # Initialize git-svn locally (be sure to use the same URL and -T/-b/-t options as were used on server) | |
463 | git-svn init http://svn.foo.org/project | |
464 | # Pull the latest changes from Subversion | |
465 | git-svn rebase | |
466 | ------------------------------------------------------------------------ | |
467 | ||
2eff1425 EW |
468 | REBASE VS. PULL/MERGE |
469 | --------------------- | |
2e93115e EW |
470 | |
471 | Originally, git-svn recommended that the remotes/git-svn branch be | |
2eff1425 EW |
472 | pulled or merged from. This is because the author favored |
473 | 'git-svn set-tree B' to commit a single head rather than the | |
474 | 'git-svn set-tree A..B' notation to commit multiple commits. | |
475 | ||
476 | If you use 'git-svn set-tree A..B' to commit several diffs and you do | |
477 | not have the latest remotes/git-svn merged into my-branch, you should | |
a81ed0b6 | 478 | use 'git-svn rebase' to update your work branch instead of 'git pull' or |
2eff1425 EW |
479 | 'git merge'. 'pull/merge' can cause non-linear history to be flattened |
480 | when committing into SVN, which can lead to merge commits reversing | |
481 | previous commits in SVN. | |
2e93115e | 482 | |
3397f9df EW |
483 | DESIGN PHILOSOPHY |
484 | ----------------- | |
485 | Merge tracking in Subversion is lacking and doing branched development | |
bd43098c EW |
486 | with Subversion can be cumbersome as a result. While git-svn can track |
487 | copy history (including branches and tags) for repositories adopting a | |
488 | standard layout, it cannot yet represent merge history that happened | |
489 | inside git back upstream to SVN users. Therefore it is advised that | |
490 | users keep history as linear as possible inside git to ease | |
491 | compatibility with SVN (see the CAVEATS section below). | |
1d52aba8 | 492 | |
aabb2e51 EW |
493 | CAVEATS |
494 | ------- | |
495 | ||
496 | For the sake of simplicity and interoperating with a less-capable system | |
497 | (SVN), it is recommended that all git-svn users clone, fetch and dcommit | |
498 | directly from the SVN server, and avoid all git-clone/pull/merge/push | |
499 | operations between git repositories and branches. The recommended | |
500 | method of exchanging code between git branches and users is | |
501 | git-format-patch and git-am, or just dcommiting to the SVN repository. | |
502 | ||
503 | Running 'git-merge' or 'git-pull' is NOT recommended on a branch you | |
504 | plan to dcommit from. Subversion does not represent merges in any | |
505 | reasonable or useful fashion; so users using Subversion cannot see any | |
506 | merges you've made. Furthermore, if you merge or pull from a git branch | |
507 | that is a mirror of an SVN branch, dcommit may commit to the wrong | |
508 | branch. | |
509 | ||
510 | 'git-clone' does not clone branches under the refs/remotes/ hierarchy or | |
511 | any git-svn metadata, or config. So repositories created and managed with | |
512 | using git-svn should use rsync(1) for cloning, if cloning is to be done | |
513 | at all. | |
514 | ||
515 | Since 'dcommit' uses rebase internally, any git branches you git-push to | |
516 | before dcommit on will require forcing an overwrite of the existing ref | |
517 | on the remote repository. This is generally considered bad practice, | |
518 | see the git-push(1) documentation for details. | |
519 | ||
520 | Do not use the --amend option of git-commit(1) on a change you've | |
521 | already dcommitted. It is considered bad practice to --amend commits | |
522 | you've already pushed to a remote repository for other users, and | |
523 | dcommit with SVN is analogous to that. | |
524 | ||
3397f9df EW |
525 | BUGS |
526 | ---- | |
e8f5d908 | 527 | |
a81ed0b6 EW |
528 | We ignore all SVN properties except svn:executable. Any unhandled |
529 | properties are logged to $GIT_DIR/svn/<refname>/unhandled.log | |
3397f9df | 530 | |
bbe0c9b8 EW |
531 | Renamed and copied directories are not detected by git and hence not |
532 | tracked when committing to SVN. I do not plan on adding support for | |
533 | this as it's quite difficult and time-consuming to get working for all | |
a81ed0b6 EW |
534 | the possible corner cases (git doesn't do it, either). Committing |
535 | renamed and copied files are fully supported if they're similar enough | |
536 | for git to detect them. | |
bbe0c9b8 | 537 | |
a836a0e1 EW |
538 | CONFIGURATION |
539 | ------------- | |
540 | ||
541 | git-svn stores [svn-remote] configuration information in the | |
542 | repository .git/config file. It is similar the core git | |
543 | [remote] sections except 'fetch' keys do not accept glob | |
544 | arguments; but they are instead handled by the 'branches' | |
545 | and 'tags' keys. Since some SVN repositories are oddly | |
546 | configured with multiple projects glob expansions such those | |
547 | listed below are allowed: | |
548 | ||
549 | ------------------------------------------------------------------------ | |
550 | [svn-remote "project-a"] | |
551 | url = http://server.org/svn | |
552 | branches = branches/*/project-a:refs/remotes/project-a/branches/* | |
553 | tags = tags/*/project-a:refs/remotes/project-a/tags/* | |
554 | trunk = trunk/project-a:refs/remotes/project-a/trunk | |
555 | ------------------------------------------------------------------------ | |
556 | ||
557 | Keep in mind that the '*' (asterisk) wildcard of the local ref | |
d37a8de0 | 558 | (right of the ':') *must* be the farthest right path component; |
a836a0e1 | 559 | however the remote wildcard may be anywhere as long as it's own |
02783075 | 560 | independent path component (surrounded by '/' or EOL). This |
a836a0e1 EW |
561 | type of configuration is not automatically created by 'init' and |
562 | should be manually entered with a text-editor or using | |
563 | gitlink:git-config[1] | |
564 | ||
2e93115e EW |
565 | SEE ALSO |
566 | -------- | |
567 | gitlink:git-rebase[1] | |
568 | ||
3397f9df EW |
569 | Author |
570 | ------ | |
571 | Written by Eric Wong <normalperson@yhbt.net>. | |
572 | ||
573 | Documentation | |
574 | ------------- | |
575 | Written by Eric Wong <normalperson@yhbt.net>. |