]>
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 | |
0ea4d4c9 JF |
196 | -- |
197 | ||
3397f9df EW |
198 | OPTIONS |
199 | ------- | |
0ea4d4c9 JF |
200 | -- |
201 | ||
a836a0e1 | 202 | --shared[={false|true|umask|group|all|world|everybody}]:: |
e8f5d908 EW |
203 | --template=<template_directory>:: |
204 | Only used with the 'init' command. | |
5c94f87e | 205 | These are passed directly to gitlink:git-init[1]. |
e8f5d908 | 206 | |
3397f9df EW |
207 | -r <ARG>:: |
208 | --revision <ARG>:: | |
3397f9df | 209 | |
a836a0e1 | 210 | Used with the 'fetch' command. |
0ea4d4c9 | 211 | |
a836a0e1 EW |
212 | This allows revision ranges for partial/cauterized history |
213 | to be supported. $NUMBER, $NUMBER1:$NUMBER2 (numeric ranges), | |
214 | $NUMBER:HEAD, and BASE:$NUMBER are all supported. | |
3397f9df | 215 | |
a836a0e1 EW |
216 | This can allow you to make partial mirrors when running fetch; |
217 | but is generally not recommended because history will be skipped | |
218 | and lost. | |
3397f9df EW |
219 | |
220 | -:: | |
221 | --stdin:: | |
3397f9df | 222 | |
3289e86e | 223 | Only used with the 'set-tree' command. |
0ea4d4c9 JF |
224 | |
225 | Read a list of commits from stdin and commit them in reverse | |
226 | order. Only the leading sha1 is read from each line, so | |
227 | git-rev-list --pretty=oneline output can be used. | |
3397f9df EW |
228 | |
229 | --rmdir:: | |
3397f9df | 230 | |
3289e86e | 231 | Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands. |
0ea4d4c9 JF |
232 | |
233 | Remove directories from the SVN tree if there are no files left | |
234 | behind. SVN can version empty directories, and they are not | |
235 | removed by default if there are no files left in them. git | |
236 | cannot version empty directories. Enabling this flag will make | |
237 | the commit to SVN act like git. | |
3397f9df | 238 | |
e0d10e1c | 239 | config key: svn.rmdir |
20b1d700 | 240 | |
3397f9df EW |
241 | -e:: |
242 | --edit:: | |
3397f9df | 243 | |
3289e86e | 244 | Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands. |
3397f9df | 245 | |
0ea4d4c9 JF |
246 | Edit the commit message before committing to SVN. This is off by |
247 | default for objects that are commits, and forced on when committing | |
248 | tree objects. | |
249 | ||
e0d10e1c | 250 | config key: svn.edit |
20b1d700 | 251 | |
72942938 EW |
252 | -l<num>:: |
253 | --find-copies-harder:: | |
72942938 | 254 | |
3289e86e | 255 | Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands. |
0ea4d4c9 JF |
256 | |
257 | They are both passed directly to git-diff-tree see | |
258 | gitlink:git-diff-tree[1] for more information. | |
72942938 | 259 | |
0ea4d4c9 | 260 | [verse] |
e0d10e1c TP |
261 | config key: svn.l |
262 | config key: svn.findcopiesharder | |
20b1d700 | 263 | |
81c5a0e6 EW |
264 | -A<filename>:: |
265 | --authors-file=<filename>:: | |
266 | ||
0ea4d4c9 JF |
267 | Syntax is compatible with the files used by git-svnimport and |
268 | git-cvsimport: | |
81c5a0e6 EW |
269 | |
270 | ------------------------------------------------------------------------ | |
0ea4d4c9 | 271 | loginname = Joe User <user@example.com> |
81c5a0e6 EW |
272 | ------------------------------------------------------------------------ |
273 | ||
0ea4d4c9 JF |
274 | If this option is specified and git-svn encounters an SVN |
275 | committer name that does not exist in the authors-file, git-svn | |
276 | will abort operation. The user will then have to add the | |
277 | appropriate entry. Re-running the previous git-svn command | |
278 | after the authors-file is modified should continue operation. | |
81c5a0e6 | 279 | |
e0d10e1c | 280 | config key: svn.authorsfile |
e8f5d908 EW |
281 | |
282 | -q:: | |
283 | --quiet:: | |
cec21ca7 | 284 | Make git-svn less verbose. |
e8f5d908 EW |
285 | |
286 | --repack[=<n>]:: | |
112f6385 SV |
287 | --repack-flags=<flags>:: |
288 | ||
289 | These should help keep disk usage sane for large fetches | |
290 | with many revisions. | |
e8f5d908 | 291 | |
112f6385 SV |
292 | --repack takes an optional argument for the number of revisions |
293 | to fetch before repacking. This defaults to repacking every | |
294 | 1000 commits fetched if no argument is specified. | |
e8f5d908 | 295 | |
112f6385 | 296 | --repack-flags are passed directly to gitlink:git-repack[1]. |
e8f5d908 | 297 | |
112f6385 | 298 | [verse] |
e0d10e1c TP |
299 | config key: svn.repack |
300 | config key: svn.repackflags | |
0ea4d4c9 | 301 | |
b22d4497 EW |
302 | -m:: |
303 | --merge:: | |
304 | -s<strategy>:: | |
305 | --strategy=<strategy>:: | |
306 | ||
a81ed0b6 | 307 | These are only used with the 'dcommit' and 'rebase' commands. |
b22d4497 EW |
308 | |
309 | Passed directly to git-rebase when using 'dcommit' if a | |
310 | 'git-reset' cannot be used (see dcommit). | |
311 | ||
312 | -n:: | |
313 | --dry-run:: | |
314 | ||
315 | This is only used with the 'dcommit' command. | |
316 | ||
317 | Print out the series of git arguments that would show | |
318 | which diffs would be committed to SVN. | |
319 | ||
0ea4d4c9 | 320 | -- |
81c5a0e6 | 321 | |
448c81b4 EW |
322 | ADVANCED OPTIONS |
323 | ---------------- | |
0ea4d4c9 JF |
324 | -- |
325 | ||
448c81b4 EW |
326 | -i<GIT_SVN_ID>:: |
327 | --id <GIT_SVN_ID>:: | |
0ea4d4c9 | 328 | |
a836a0e1 EW |
329 | This sets GIT_SVN_ID (instead of using the environment). This |
330 | allows the user to override the default refname to fetch from | |
331 | when tracking a single URL. The 'log' and 'dcommit' commands | |
332 | no longer require this switch as an argument. | |
0ea4d4c9 | 333 | |
9760adcc EW |
334 | -R<remote name>:: |
335 | --svn-remote <remote name>:: | |
336 | Specify the [svn-remote "<remote name>"] section to use, | |
a836a0e1 EW |
337 | this allows SVN multiple repositories to be tracked. |
338 | Default: "svn" | |
9760adcc | 339 | |
e8f5d908 EW |
340 | --follow-parent:: |
341 | This is especially helpful when we're tracking a directory | |
342 | that has been moved around within the repository, or if we | |
343 | started tracking a branch and never tracked the trunk it was | |
0bed5eaa EW |
344 | descended from. This feature is enabled by default, use |
345 | --no-follow-parent to disable it. | |
e8f5d908 | 346 | |
e0d10e1c | 347 | config key: svn.followparent |
e8f5d908 | 348 | |
a81ed0b6 EW |
349 | -- |
350 | CONFIG FILE-ONLY OPTIONS | |
351 | ------------------------ | |
352 | -- | |
353 | ||
0dfaf0a4 EW |
354 | svn.noMetadata:: |
355 | svn-remote.<name>.noMetadata:: | |
e8f5d908 | 356 | |
112f6385 SV |
357 | This gets rid of the git-svn-id: lines at the end of every commit. |
358 | ||
359 | If you lose your .git/svn/git-svn/.rev_db file, git-svn will not | |
360 | be able to rebuild it and you won't be able to fetch again, | |
361 | either. This is fine for one-shot imports. | |
e8f5d908 | 362 | |
112f6385 SV |
363 | The 'git-svn log' command will not work on repositories using |
364 | this, either. Using this conflicts with the 'useSvmProps' | |
365 | option for (hopefully) obvious reasons. | |
97ae0911 | 366 | |
0dfaf0a4 EW |
367 | svn.useSvmProps:: |
368 | svn-remote.<name>.useSvmProps:: | |
97ae0911 | 369 | |
112f6385 SV |
370 | This allows git-svn to re-map repository URLs and UUIDs from |
371 | mirrors created using SVN::Mirror (or svk) for metadata. | |
372 | ||
373 | If an SVN revision has a property, "svm:headrev", it is likely | |
374 | that the revision was created by SVN::Mirror (also used by SVK). | |
375 | The property contains a repository UUID and a revision. We want | |
376 | to make it look like we are mirroring the original URL, so | |
377 | introduce a helper function that returns the original identity | |
378 | URL and UUID, and use it when generating metadata in commit | |
379 | messages. | |
97ae0911 | 380 | |
0dfaf0a4 EW |
381 | svn.useSvnsyncProps:: |
382 | svn-remote.<name>.useSvnsyncprops:: | |
a81ed0b6 EW |
383 | Similar to the useSvmProps option; this is for users |
384 | of the svnsync(1) command distributed with SVN 1.4.x and | |
385 | later. | |
386 | ||
0dfaf0a4 | 387 | svn-remote.<name>.rewriteRoot:: |
a81ed0b6 EW |
388 | This allows users to create repositories from alternate |
389 | URLs. For example, an administrator could run git-svn on the | |
390 | server locally (accessing via file://) but wish to distribute | |
391 | the repository with a public http:// or svn:// URL in the | |
392 | metadata so users of it will see the public URL. | |
393 | ||
a81ed0b6 EW |
394 | Since the noMetadata, rewriteRoot, useSvnsyncProps and useSvmProps |
395 | options all affect the metadata generated and used by git-svn; they | |
396 | *must* be set in the configuration file before any history is imported | |
397 | and these settings should never be changed once they are set. | |
398 | ||
399 | Additionally, only one of these four options can be used per-svn-remote | |
400 | section because they affect the 'git-svn-id:' metadata line. | |
e8f5d908 | 401 | |
0ea4d4c9 | 402 | -- |
448c81b4 | 403 | |
112f6385 SV |
404 | BASIC EXAMPLES |
405 | -------------- | |
3397f9df | 406 | |
06ada152 | 407 | Tracking and contributing to the trunk of a Subversion-managed project: |
3397f9df | 408 | |
20b1d700 | 409 | ------------------------------------------------------------------------ |
a81ed0b6 EW |
410 | # Clone a repo (like git clone): |
411 | git-svn clone http://svn.foo.org/project/trunk | |
412 | # Enter the newly cloned directory: | |
413 | cd trunk | |
414 | # You should be on master branch, double-check with git-branch | |
415 | git branch | |
416 | # Do some work and commit locally to git: | |
417 | git commit ... | |
418 | # Something is committed to SVN, rebase your local changes against the | |
419 | # latest changes in SVN: | |
420 | git-svn rebase | |
421 | # Now commit your changes (that were committed previously using git) to SVN, | |
422 | # as well as automatically updating your working HEAD: | |
4511c899 | 423 | git-svn dcommit |
20b1d700 | 424 | # Append svn:ignore settings to the default git exclude file: |
8f22562c | 425 | git-svn show-ignore >> .git/info/exclude |
20b1d700 | 426 | ------------------------------------------------------------------------ |
3397f9df | 427 | |
0d313b2b EW |
428 | Tracking and contributing to an entire Subversion-managed project |
429 | (complete with a trunk, tags and branches): | |
0d313b2b EW |
430 | |
431 | ------------------------------------------------------------------------ | |
a81ed0b6 EW |
432 | # Clone a repo (like git clone): |
433 | git-svn clone http://svn.foo.org/project -T trunk -b branches -t tags | |
434 | # View all branches and tags you have cloned: | |
435 | git branch -r | |
436 | # Reset your master to trunk (or any other branch, replacing 'trunk' | |
437 | # with the appropriate name): | |
438 | git reset --hard remotes/trunk | |
439 | # You may only dcommit to one branch/tag/trunk at a time. The usage | |
20f50f16 | 440 | # of dcommit/rebase/show-ignore should be the same as above. |
0d313b2b EW |
441 | ------------------------------------------------------------------------ |
442 | ||
7d4aef40 AR |
443 | The initial 'git-svn clone' can be quite time-consuming |
444 | (especially for large Subversion repositories). If multiple | |
445 | people (or one person with multiple machines) want to use | |
446 | git-svn to interact with the same Subversion repository, you can | |
447 | do the initial 'git-svn clone' to a repository on a server and | |
448 | have each person clone that repository with 'git clone': | |
449 | ||
450 | ------------------------------------------------------------------------ | |
451 | # Do the initial import on a server | |
452 | ssh server "cd /pub && git-svn clone http://svn.foo.org/project | |
453 | # Clone locally | |
454 | git clone server:/pub/project | |
455 | # Tell git-svn which branch contains the Subversion commits | |
456 | git update-ref refs/remotes/git-svn origin/master | |
457 | # Initialize git-svn locally (be sure to use the same URL and -T/-b/-t options as were used on server) | |
458 | git-svn init http://svn.foo.org/project | |
459 | # Pull the latest changes from Subversion | |
460 | git-svn rebase | |
461 | ------------------------------------------------------------------------ | |
462 | ||
2eff1425 EW |
463 | REBASE VS. PULL/MERGE |
464 | --------------------- | |
2e93115e EW |
465 | |
466 | Originally, git-svn recommended that the remotes/git-svn branch be | |
2eff1425 EW |
467 | pulled or merged from. This is because the author favored |
468 | 'git-svn set-tree B' to commit a single head rather than the | |
469 | 'git-svn set-tree A..B' notation to commit multiple commits. | |
470 | ||
471 | If you use 'git-svn set-tree A..B' to commit several diffs and you do | |
472 | not have the latest remotes/git-svn merged into my-branch, you should | |
a81ed0b6 | 473 | use 'git-svn rebase' to update your work branch instead of 'git pull' or |
2eff1425 EW |
474 | 'git merge'. 'pull/merge' can cause non-linear history to be flattened |
475 | when committing into SVN, which can lead to merge commits reversing | |
476 | previous commits in SVN. | |
2e93115e | 477 | |
3397f9df EW |
478 | DESIGN PHILOSOPHY |
479 | ----------------- | |
480 | Merge tracking in Subversion is lacking and doing branched development | |
bd43098c EW |
481 | with Subversion can be cumbersome as a result. While git-svn can track |
482 | copy history (including branches and tags) for repositories adopting a | |
483 | standard layout, it cannot yet represent merge history that happened | |
484 | inside git back upstream to SVN users. Therefore it is advised that | |
485 | users keep history as linear as possible inside git to ease | |
486 | compatibility with SVN (see the CAVEATS section below). | |
1d52aba8 | 487 | |
aabb2e51 EW |
488 | CAVEATS |
489 | ------- | |
490 | ||
491 | For the sake of simplicity and interoperating with a less-capable system | |
492 | (SVN), it is recommended that all git-svn users clone, fetch and dcommit | |
493 | directly from the SVN server, and avoid all git-clone/pull/merge/push | |
494 | operations between git repositories and branches. The recommended | |
495 | method of exchanging code between git branches and users is | |
496 | git-format-patch and git-am, or just dcommiting to the SVN repository. | |
497 | ||
498 | Running 'git-merge' or 'git-pull' is NOT recommended on a branch you | |
499 | plan to dcommit from. Subversion does not represent merges in any | |
500 | reasonable or useful fashion; so users using Subversion cannot see any | |
501 | merges you've made. Furthermore, if you merge or pull from a git branch | |
502 | that is a mirror of an SVN branch, dcommit may commit to the wrong | |
503 | branch. | |
504 | ||
505 | 'git-clone' does not clone branches under the refs/remotes/ hierarchy or | |
506 | any git-svn metadata, or config. So repositories created and managed with | |
507 | using git-svn should use rsync(1) for cloning, if cloning is to be done | |
508 | at all. | |
509 | ||
510 | Since 'dcommit' uses rebase internally, any git branches you git-push to | |
511 | before dcommit on will require forcing an overwrite of the existing ref | |
512 | on the remote repository. This is generally considered bad practice, | |
513 | see the git-push(1) documentation for details. | |
514 | ||
515 | Do not use the --amend option of git-commit(1) on a change you've | |
516 | already dcommitted. It is considered bad practice to --amend commits | |
517 | you've already pushed to a remote repository for other users, and | |
518 | dcommit with SVN is analogous to that. | |
519 | ||
3397f9df EW |
520 | BUGS |
521 | ---- | |
e8f5d908 | 522 | |
a81ed0b6 EW |
523 | We ignore all SVN properties except svn:executable. Any unhandled |
524 | properties are logged to $GIT_DIR/svn/<refname>/unhandled.log | |
3397f9df | 525 | |
bbe0c9b8 EW |
526 | Renamed and copied directories are not detected by git and hence not |
527 | tracked when committing to SVN. I do not plan on adding support for | |
528 | this as it's quite difficult and time-consuming to get working for all | |
a81ed0b6 EW |
529 | the possible corner cases (git doesn't do it, either). Committing |
530 | renamed and copied files are fully supported if they're similar enough | |
531 | for git to detect them. | |
bbe0c9b8 | 532 | |
a836a0e1 EW |
533 | CONFIGURATION |
534 | ------------- | |
535 | ||
536 | git-svn stores [svn-remote] configuration information in the | |
537 | repository .git/config file. It is similar the core git | |
538 | [remote] sections except 'fetch' keys do not accept glob | |
539 | arguments; but they are instead handled by the 'branches' | |
540 | and 'tags' keys. Since some SVN repositories are oddly | |
541 | configured with multiple projects glob expansions such those | |
542 | listed below are allowed: | |
543 | ||
544 | ------------------------------------------------------------------------ | |
545 | [svn-remote "project-a"] | |
546 | url = http://server.org/svn | |
547 | branches = branches/*/project-a:refs/remotes/project-a/branches/* | |
548 | tags = tags/*/project-a:refs/remotes/project-a/tags/* | |
549 | trunk = trunk/project-a:refs/remotes/project-a/trunk | |
550 | ------------------------------------------------------------------------ | |
551 | ||
552 | Keep in mind that the '*' (asterisk) wildcard of the local ref | |
d37a8de0 | 553 | (right of the ':') *must* be the farthest right path component; |
a836a0e1 | 554 | however the remote wildcard may be anywhere as long as it's own |
02783075 | 555 | independent path component (surrounded by '/' or EOL). This |
a836a0e1 EW |
556 | type of configuration is not automatically created by 'init' and |
557 | should be manually entered with a text-editor or using | |
558 | gitlink:git-config[1] | |
559 | ||
2e93115e EW |
560 | SEE ALSO |
561 | -------- | |
562 | gitlink:git-rebase[1] | |
563 | ||
3397f9df EW |
564 | Author |
565 | ------ | |
566 | Written by Eric Wong <normalperson@yhbt.net>. | |
567 | ||
568 | Documentation | |
569 | ------------- | |
570 | Written by Eric Wong <normalperson@yhbt.net>. |