]>
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 | -------- | |
b1889c36 | 10 | 'git svn' <command> [options] [arguments] |
3397f9df EW |
11 | |
12 | DESCRIPTION | |
13 | ----------- | |
ba020ef5 | 14 | 'git-svn' is a simple conduit for changesets between Subversion and git. |
8cb070a4 | 15 | It provides a bidirectional flow of changes between a Subversion and a git |
1168d402 | 16 | repository. |
3397f9df | 17 | |
8cb070a4 BG |
18 | 'git-svn' can track a single Subversion branch simply by using a |
19 | URL to the branch, follow branches laid out in the Subversion recommended | |
20 | method (trunk, branches, tags directories) with the --stdlayout option, or | |
21 | follow branches in any layout with the -T/-t/-b options (see options to | |
22 | 'init' below, and also the 'clone' command). | |
3397f9df | 23 | |
8cb070a4 BG |
24 | Once tracking a Subversion branch (with any of the above methods), the git |
25 | repository can be updated from Subversion by the 'fetch' command and | |
26 | Subversion updated from git by the 'dcommit' command. | |
3397f9df EW |
27 | |
28 | COMMANDS | |
29 | -------- | |
0ea4d4c9 JF |
30 | -- |
31 | ||
32 | 'init':: | |
a836a0e1 | 33 | Initializes an empty git repository with additional |
ba020ef5 | 34 | metadata directories for 'git-svn'. The Subversion URL |
a836a0e1 EW |
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. |
de451dff AP |
64 | --use-log-author;; |
65 | When retrieving svn commits into git (as part of fetch, rebase, or | |
66 | dcommit operations), look for the first From: or Signed-off-by: line | |
67 | in the log message and use that as the author string. | |
9e72732e AP |
68 | --add-author-from;; |
69 | When committing to svn from git (as part of commit or dcommit | |
70 | operations), if the existing log message doesn't already have a | |
71 | From: or Signed-off-by: line, append a From: line based on the | |
72 | git commit's author string. If you use this, then --use-log-author | |
73 | will retrieve a valid author string for all commits. | |
cc1793e2 | 74 | --username=<USER>;; |
a0d7fe3f SV |
75 | For transports that SVN handles authentication for (http, |
76 | https, and plain svn), specify the username. For other | |
77 | transports (eg svn+ssh://), you must include the username in | |
78 | the URL, eg svn+ssh://foo@svn.bar.com/project | |
cc1793e2 | 79 | --prefix=<prefix>;; |
a836a0e1 EW |
80 | This allows one to specify a prefix which is prepended |
81 | to the names of remotes if trunk/branches/tags are | |
82 | specified. The prefix does not automatically include a | |
83 | trailing slash, so be sure you include one in the | |
0d351e9c GP |
84 | argument if that is what you want. If --branches/-b is |
85 | specified, the prefix must include a trailing slash. | |
86 | Setting a prefix is useful if you wish to track multiple | |
87 | projects that share a common repository. | |
81c5a0e6 | 88 | |
a836a0e1 | 89 | 'fetch':: |
a836a0e1 EW |
90 | Fetch unfetched revisions from the Subversion remote we are |
91 | tracking. The name of the [svn-remote "..."] section in the | |
92 | .git/config file may be specified as an optional command-line | |
93 | argument. | |
b705ba43 | 94 | |
e82f0d73 PH |
95 | --localtime;; |
96 | Store Git commit times in the local timezone instead of UTC. This | |
97 | makes 'git-log' (even without --date=local) show the same times | |
98 | that `svn log` would in the local timezone. | |
99 | ||
100 | This doesn't interfere with interoperating with the Subversion | |
101 | repository you cloned from, but if you wish for your local Git | |
102 | repository to be able to interoperate with someone else's local Git | |
103 | repository, either don't use this option or you should both use it in | |
104 | the same local timezone. | |
105 | ||
6076b843 VS |
106 | --ignore-paths=<regex>;; |
107 | This allows one to specify Perl regular expression that will | |
108 | cause skipping of all matching paths from checkout from SVN. | |
109 | Examples: | |
110 | ||
111 | --ignore-paths="^doc" - skip "doc*" directory for every fetch. | |
112 | ||
113 | --ignore-paths="^[^/]+/(?:branches|tags)" - skip "branches" | |
114 | and "tags" of first level directories. | |
115 | ||
116 | Regular expression is not persistent, you should specify | |
117 | it every time when fetching. | |
118 | ||
a81ed0b6 EW |
119 | 'clone':: |
120 | Runs 'init' and 'fetch'. It will automatically create a | |
121 | directory based on the basename of the URL passed to it; | |
122 | or if a second argument is passed; it will create a directory | |
123 | and work within that. It accepts all arguments that the | |
124 | 'init' and 'fetch' commands accept; with the exception of | |
125 | '--fetch-all'. After a repository is cloned, the 'fetch' | |
126 | command will be able to update revisions without affecting | |
127 | the working tree; and the 'rebase' command will be able | |
128 | to update the working tree with the latest changes. | |
129 | ||
130 | 'rebase':: | |
131 | This fetches revisions from the SVN parent of the current HEAD | |
132 | and rebases the current (uncommitted to SVN) work against it. | |
133 | ||
ba020ef5 JN |
134 | This works similarly to `svn update` or 'git-pull' except that |
135 | it preserves linear history with 'git-rebase' instead of | |
a0178ae2 | 136 | 'git-merge' for ease of dcommitting with 'git-svn'. |
a81ed0b6 | 137 | |
ba020ef5 | 138 | This accepts all options that 'git-svn fetch' and 'git-rebase' |
483bc4f0 | 139 | accept. However, '--fetch-all' only fetches from the current |
112f6385 | 140 | [svn-remote], and not all [svn-remote] definitions. |
a81ed0b6 | 141 | |
ba020ef5 | 142 | Like 'git-rebase'; this requires that the working tree be clean |
112f6385 | 143 | and have no uncommitted changes. |
cc1793e2 | 144 | |
dee41f3e EW |
145 | -l;; |
146 | --local;; | |
ba020ef5 | 147 | Do not fetch remotely; only run 'git-rebase' against the |
dee41f3e | 148 | last fetched commit from the upstream SVN. |
a81ed0b6 | 149 | |
b22d4497 | 150 | 'dcommit':: |
2eff1425 | 151 | Commit each diff from a specified head directly to the SVN |
b22d4497 | 152 | repository, and then rebase or reset (depending on whether or |
2eff1425 EW |
153 | not there is a diff between SVN and head). This will create |
154 | a revision in SVN for each commit in git. | |
ba020ef5 | 155 | It is recommended that you run 'git-svn' fetch and rebase (not |
2eff1425 EW |
156 | pull or merge) your commits against the latest changes in the |
157 | SVN repository. | |
dd31da2f EW |
158 | An optional command-line argument may be specified as an |
159 | alternative to HEAD. | |
3289e86e | 160 | This is advantageous over 'set-tree' (below) because it produces |
b22d4497 | 161 | cleaner, more linear history. |
171af110 KW |
162 | + |
163 | --no-rebase;; | |
164 | After committing, do not rebase or reset. | |
ba24e745 EW |
165 | --commit-url <URL>;; |
166 | Commit to this SVN URL (the full path). This is intended to | |
167 | allow existing git-svn repositories created with one transport | |
168 | method (e.g. `svn://` or `http://` for anonymous read) to be | |
169 | reused if a user is later given access to an alternate transport | |
170 | method (e.g. `svn+ssh://` or `https://`) for commit. | |
171 | ||
0df84059 PO |
172 | config key: svn-remote.<name>.commiturl |
173 | ||
174 | config key: svn.commiturl (overwrites all svn-remote.<name>.commiturl options) | |
175 | ||
ba24e745 EW |
176 | Using this option for any other purpose (don't ask) |
177 | is very strongly discouraged. | |
112f6385 | 178 | -- |
b22d4497 | 179 | |
5de70efb FR |
180 | 'branch':: |
181 | Create a branch in the SVN repository. | |
182 | ||
183 | -m;; | |
184 | --message;; | |
185 | Allows to specify the commit message. | |
186 | ||
187 | -t;; | |
188 | --tag;; | |
189 | Create a tag by using the tags_subdir instead of the branches_subdir | |
190 | specified during git svn init. | |
191 | ||
192 | 'tag':: | |
193 | Create a tag in the SVN repository. This is a shorthand for | |
194 | 'branch -t'. | |
195 | ||
e8f5d908 EW |
196 | 'log':: |
197 | This should make it easy to look up svn log messages when svn | |
198 | users refer to -r/--revision numbers. | |
112f6385 SV |
199 | + |
200 | The following features from `svn log' are supported: | |
201 | + | |
202 | -- | |
203 | --revision=<n>[:<n>];; | |
204 | is supported, non-numeric args are not: | |
205 | HEAD, NEXT, BASE, PREV, etc ... | |
206 | -v/--verbose;; | |
207 | it's not completely compatible with the --verbose | |
208 | output in svn log, but reasonably close. | |
209 | --limit=<n>;; | |
210 | is NOT the same as --max-count, doesn't count | |
211 | merged/excluded commits | |
212 | --incremental;; | |
213 | supported | |
214 | -- | |
215 | + | |
216 | New features: | |
217 | + | |
218 | -- | |
219 | --show-commit;; | |
220 | shows the git commit sha1, as well | |
221 | --oneline;; | |
222 | our version of --pretty=oneline | |
223 | -- | |
224 | + | |
a50a5c8f MV |
225 | NOTE: SVN itself only stores times in UTC and nothing else. The regular svn |
226 | client converts the UTC time to the local time (or based on the TZ= | |
227 | environment). This command has the same behaviour. | |
228 | + | |
ba020ef5 | 229 | Any other arguments are passed directly to 'git-log' |
e8f5d908 | 230 | |
6fb5375e | 231 | 'blame':: |
4be40381 SG |
232 | Show what revision and author last modified each line of a file. The |
233 | output of this mode is format-compatible with the output of | |
234 | `svn blame' by default. Like the SVN blame command, | |
235 | local uncommitted changes in the working copy are ignored; | |
236 | the version of the file in the HEAD revision is annotated. Unknown | |
ba020ef5 | 237 | arguments are passed directly to 'git-blame'. |
6fb5375e | 238 | + |
4be40381 | 239 | --git-format;; |
ba020ef5 | 240 | Produce output in the same format as 'git-blame', but with |
4be40381 SG |
241 | SVN revision numbers instead of git commit hashes. In this mode, |
242 | changes that haven't been committed to SVN (including local | |
243 | working-copy edits) are shown as revision 0. | |
6fb5375e | 244 | |
112f6385 | 245 | -- |
26e60160 AR |
246 | 'find-rev':: |
247 | When given an SVN revision number of the form 'rN', returns the | |
b3cb7e45 AR |
248 | corresponding git commit hash (this can optionally be followed by a |
249 | tree-ish to specify which branch should be searched). When given a | |
250 | tree-ish, returns the corresponding SVN revision number. | |
26e60160 | 251 | |
3289e86e | 252 | 'set-tree':: |
e8f5d908 | 253 | You should consider using 'dcommit' instead of this command. |
3397f9df EW |
254 | Commit specified commit or tree objects to SVN. This relies on |
255 | your imported fetch data being up-to-date. This makes | |
256 | absolutely no attempts to do patching when committing to SVN, it | |
257 | simply overwrites files with those specified in the tree or | |
258 | commit. All merging is assumed to have taken place | |
ba020ef5 | 259 | independently of 'git-svn' functions. |
3397f9df | 260 | |
da060c67 | 261 | 'create-ignore':: |
da060c67 GH |
262 | Recursively finds the svn:ignore property on directories and |
263 | creates matching .gitignore files. The resulting files are staged to | |
69239728 | 264 | be committed, but are not committed. Use -r/--revision to refer to a |
1168d402 | 265 | specific revision. |
da060c67 | 266 | |
0ea4d4c9 | 267 | 'show-ignore':: |
8f22562c EW |
268 | Recursively finds and lists the svn:ignore property on |
269 | directories. The output is suitable for appending to | |
270 | the $GIT_DIR/info/exclude file. | |
271 | ||
e8f5d908 EW |
272 | 'commit-diff':: |
273 | Commits the diff of two tree-ish arguments from the | |
8cb070a4 | 274 | command-line. This command does not rely on being inside an `git-svn |
483bc4f0 | 275 | init`-ed repository. This command takes three arguments, (a) the |
e8f5d908 EW |
276 | original tree to diff against, (b) the new tree result, (c) the |
277 | URL of the target Subversion repository. The final argument | |
ba020ef5 JN |
278 | (URL) may be omitted if you are working from a 'git-svn'-aware |
279 | repository (that has been `init`-ed with 'git-svn'). | |
45bf473a | 280 | The -r<revision> option is required for this. |
e8f5d908 | 281 | |
e6fefa92 DK |
282 | 'info':: |
283 | Shows information about a file or directory similar to what | |
284 | `svn info' provides. Does not currently support a -r/--revision | |
8b014d71 DK |
285 | argument. Use the --url option to output only the value of the |
286 | 'URL:' field. | |
e6fefa92 | 287 | |
69239728 GH |
288 | 'proplist':: |
289 | Lists the properties stored in the Subversion repository about a | |
290 | given file or directory. Use -r/--revision to refer to a specific | |
291 | Subversion revision. | |
292 | ||
293 | 'propget':: | |
294 | Gets the Subversion property given as the first argument, for a | |
295 | file. A specific revision can be specified with -r/--revision. | |
296 | ||
297 | 'show-externals':: | |
298 | Shows the Subversion externals. Use -r/--revision to specify a | |
299 | specific revision. | |
300 | ||
0ea4d4c9 JF |
301 | -- |
302 | ||
3397f9df EW |
303 | OPTIONS |
304 | ------- | |
0ea4d4c9 JF |
305 | -- |
306 | ||
a836a0e1 | 307 | --shared[={false|true|umask|group|all|world|everybody}]:: |
e8f5d908 EW |
308 | --template=<template_directory>:: |
309 | Only used with the 'init' command. | |
ba020ef5 | 310 | These are passed directly to 'git-init'. |
e8f5d908 | 311 | |
3397f9df EW |
312 | -r <ARG>:: |
313 | --revision <ARG>:: | |
3397f9df | 314 | |
a836a0e1 | 315 | Used with the 'fetch' command. |
0ea4d4c9 | 316 | |
a836a0e1 EW |
317 | This allows revision ranges for partial/cauterized history |
318 | to be supported. $NUMBER, $NUMBER1:$NUMBER2 (numeric ranges), | |
319 | $NUMBER:HEAD, and BASE:$NUMBER are all supported. | |
3397f9df | 320 | |
a836a0e1 EW |
321 | This can allow you to make partial mirrors when running fetch; |
322 | but is generally not recommended because history will be skipped | |
323 | and lost. | |
3397f9df EW |
324 | |
325 | -:: | |
326 | --stdin:: | |
3397f9df | 327 | |
3289e86e | 328 | Only used with the 'set-tree' command. |
0ea4d4c9 JF |
329 | |
330 | Read a list of commits from stdin and commit them in reverse | |
331 | order. Only the leading sha1 is read from each line, so | |
ba020ef5 | 332 | 'git-rev-list --pretty=oneline' output can be used. |
3397f9df EW |
333 | |
334 | --rmdir:: | |
3397f9df | 335 | |
3289e86e | 336 | Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands. |
0ea4d4c9 JF |
337 | |
338 | Remove directories from the SVN tree if there are no files left | |
339 | behind. SVN can version empty directories, and they are not | |
340 | removed by default if there are no files left in them. git | |
341 | cannot version empty directories. Enabling this flag will make | |
342 | the commit to SVN act like git. | |
3397f9df | 343 | |
e0d10e1c | 344 | config key: svn.rmdir |
20b1d700 | 345 | |
3397f9df EW |
346 | -e:: |
347 | --edit:: | |
3397f9df | 348 | |
3289e86e | 349 | Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands. |
3397f9df | 350 | |
0ea4d4c9 JF |
351 | Edit the commit message before committing to SVN. This is off by |
352 | default for objects that are commits, and forced on when committing | |
353 | tree objects. | |
354 | ||
e0d10e1c | 355 | config key: svn.edit |
20b1d700 | 356 | |
72942938 EW |
357 | -l<num>:: |
358 | --find-copies-harder:: | |
72942938 | 359 | |
3289e86e | 360 | Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands. |
0ea4d4c9 | 361 | |
ba020ef5 | 362 | They are both passed directly to 'git-diff-tree'; see |
5162e697 | 363 | linkgit:git-diff-tree[1] for more information. |
72942938 | 364 | |
0ea4d4c9 | 365 | [verse] |
e0d10e1c TP |
366 | config key: svn.l |
367 | config key: svn.findcopiesharder | |
20b1d700 | 368 | |
81c5a0e6 EW |
369 | -A<filename>:: |
370 | --authors-file=<filename>:: | |
371 | ||
8cb070a4 | 372 | Syntax is compatible with the file used by 'git-cvsimport': |
81c5a0e6 EW |
373 | |
374 | ------------------------------------------------------------------------ | |
0ea4d4c9 | 375 | loginname = Joe User <user@example.com> |
81c5a0e6 EW |
376 | ------------------------------------------------------------------------ |
377 | ||
ba020ef5 JN |
378 | If this option is specified and 'git-svn' encounters an SVN |
379 | committer name that does not exist in the authors-file, 'git-svn' | |
0ea4d4c9 | 380 | will abort operation. The user will then have to add the |
ba020ef5 | 381 | appropriate entry. Re-running the previous 'git-svn' command |
0ea4d4c9 | 382 | after the authors-file is modified should continue operation. |
81c5a0e6 | 383 | |
e0d10e1c | 384 | config key: svn.authorsfile |
e8f5d908 EW |
385 | |
386 | -q:: | |
387 | --quiet:: | |
49750f30 SA |
388 | Make 'git-svn' less verbose. Specify a second time to make it |
389 | even less verbose. | |
e8f5d908 EW |
390 | |
391 | --repack[=<n>]:: | |
112f6385 SV |
392 | --repack-flags=<flags>:: |
393 | ||
394 | These should help keep disk usage sane for large fetches | |
395 | with many revisions. | |
e8f5d908 | 396 | |
112f6385 SV |
397 | --repack takes an optional argument for the number of revisions |
398 | to fetch before repacking. This defaults to repacking every | |
399 | 1000 commits fetched if no argument is specified. | |
e8f5d908 | 400 | |
ba020ef5 | 401 | --repack-flags are passed directly to 'git-repack'. |
e8f5d908 | 402 | |
112f6385 | 403 | [verse] |
e0d10e1c TP |
404 | config key: svn.repack |
405 | config key: svn.repackflags | |
0ea4d4c9 | 406 | |
b22d4497 EW |
407 | -m:: |
408 | --merge:: | |
409 | -s<strategy>:: | |
410 | --strategy=<strategy>:: | |
411 | ||
a81ed0b6 | 412 | These are only used with the 'dcommit' and 'rebase' commands. |
b22d4497 | 413 | |
ba020ef5 JN |
414 | Passed directly to 'git-rebase' when using 'dcommit' if a |
415 | 'git-reset' cannot be used (see 'dcommit'). | |
b22d4497 EW |
416 | |
417 | -n:: | |
418 | --dry-run:: | |
419 | ||
5de70efb FR |
420 | This can be used with the 'dcommit', 'rebase', 'branch' and 'tag' |
421 | commands. | |
b22d4497 | 422 | |
7d45e146 | 423 | For 'dcommit', print out the series of git arguments that would show |
b22d4497 EW |
424 | which diffs would be committed to SVN. |
425 | ||
7d45e146 SF |
426 | For 'rebase', display the local branch associated with the upstream svn |
427 | repository associated with the current branch and the URL of svn | |
428 | repository that will be fetched from. | |
429 | ||
5de70efb FR |
430 | For 'branch' and 'tag', display the urls that will be used for copying when |
431 | creating the branch or tag. | |
432 | ||
0ea4d4c9 | 433 | -- |
81c5a0e6 | 434 | |
448c81b4 EW |
435 | ADVANCED OPTIONS |
436 | ---------------- | |
0ea4d4c9 JF |
437 | -- |
438 | ||
448c81b4 EW |
439 | -i<GIT_SVN_ID>:: |
440 | --id <GIT_SVN_ID>:: | |
0ea4d4c9 | 441 | |
a836a0e1 EW |
442 | This sets GIT_SVN_ID (instead of using the environment). This |
443 | allows the user to override the default refname to fetch from | |
444 | when tracking a single URL. The 'log' and 'dcommit' commands | |
445 | no longer require this switch as an argument. | |
0ea4d4c9 | 446 | |
9760adcc EW |
447 | -R<remote name>:: |
448 | --svn-remote <remote name>:: | |
449 | Specify the [svn-remote "<remote name>"] section to use, | |
a836a0e1 EW |
450 | this allows SVN multiple repositories to be tracked. |
451 | Default: "svn" | |
9760adcc | 452 | |
e8f5d908 EW |
453 | --follow-parent:: |
454 | This is especially helpful when we're tracking a directory | |
455 | that has been moved around within the repository, or if we | |
456 | started tracking a branch and never tracked the trunk it was | |
0bed5eaa EW |
457 | descended from. This feature is enabled by default, use |
458 | --no-follow-parent to disable it. | |
e8f5d908 | 459 | |
e0d10e1c | 460 | config key: svn.followparent |
e8f5d908 | 461 | |
a81ed0b6 EW |
462 | -- |
463 | CONFIG FILE-ONLY OPTIONS | |
464 | ------------------------ | |
465 | -- | |
466 | ||
0dfaf0a4 EW |
467 | svn.noMetadata:: |
468 | svn-remote.<name>.noMetadata:: | |
e8f5d908 | 469 | |
483bc4f0 | 470 | This gets rid of the 'git-svn-id:' lines at the end of every commit. |
112f6385 | 471 | |
ba020ef5 | 472 | If you lose your .git/svn/git-svn/.rev_db file, 'git-svn' will not |
112f6385 SV |
473 | be able to rebuild it and you won't be able to fetch again, |
474 | either. This is fine for one-shot imports. | |
e8f5d908 | 475 | |
ba020ef5 | 476 | The 'git-svn log' command will not work on repositories using |
112f6385 SV |
477 | this, either. Using this conflicts with the 'useSvmProps' |
478 | option for (hopefully) obvious reasons. | |
97ae0911 | 479 | |
0dfaf0a4 EW |
480 | svn.useSvmProps:: |
481 | svn-remote.<name>.useSvmProps:: | |
97ae0911 | 482 | |
ba020ef5 | 483 | This allows 'git-svn' to re-map repository URLs and UUIDs from |
112f6385 SV |
484 | mirrors created using SVN::Mirror (or svk) for metadata. |
485 | ||
486 | If an SVN revision has a property, "svm:headrev", it is likely | |
487 | that the revision was created by SVN::Mirror (also used by SVK). | |
488 | The property contains a repository UUID and a revision. We want | |
489 | to make it look like we are mirroring the original URL, so | |
490 | introduce a helper function that returns the original identity | |
491 | URL and UUID, and use it when generating metadata in commit | |
492 | messages. | |
97ae0911 | 493 | |
0dfaf0a4 EW |
494 | svn.useSvnsyncProps:: |
495 | svn-remote.<name>.useSvnsyncprops:: | |
a81ed0b6 EW |
496 | Similar to the useSvmProps option; this is for users |
497 | of the svnsync(1) command distributed with SVN 1.4.x and | |
498 | later. | |
499 | ||
0dfaf0a4 | 500 | svn-remote.<name>.rewriteRoot:: |
a81ed0b6 | 501 | This allows users to create repositories from alternate |
ba020ef5 | 502 | URLs. For example, an administrator could run 'git-svn' on the |
a81ed0b6 EW |
503 | server locally (accessing via file://) but wish to distribute |
504 | the repository with a public http:// or svn:// URL in the | |
505 | metadata so users of it will see the public URL. | |
506 | ||
4c58a711 EW |
507 | svn.brokenSymlinkWorkaround:: |
508 | This disables potentially expensive checks to workaround broken symlinks | |
509 | checked into SVN by broken clients. Set this option to "false" if you | |
510 | track a SVN repository with many empty blobs that are not symlinks. | |
511 | This option may be changed while "git-svn" is running and take effect on | |
512 | the next revision fetched. If unset, git-svn assumes this option to be | |
513 | "true". | |
514 | ||
3b2bbe9b JK |
515 | -- |
516 | ||
a81ed0b6 | 517 | Since the noMetadata, rewriteRoot, useSvnsyncProps and useSvmProps |
ba020ef5 | 518 | options all affect the metadata generated and used by 'git-svn'; they |
a81ed0b6 EW |
519 | *must* be set in the configuration file before any history is imported |
520 | and these settings should never be changed once they are set. | |
521 | ||
522 | Additionally, only one of these four options can be used per-svn-remote | |
523 | section because they affect the 'git-svn-id:' metadata line. | |
e8f5d908 | 524 | |
448c81b4 | 525 | |
112f6385 SV |
526 | BASIC EXAMPLES |
527 | -------------- | |
3397f9df | 528 | |
06ada152 | 529 | Tracking and contributing to the trunk of a Subversion-managed project: |
3397f9df | 530 | |
20b1d700 | 531 | ------------------------------------------------------------------------ |
a81ed0b6 | 532 | # Clone a repo (like git clone): |
2670ddce | 533 | git svn clone http://svn.example.com/project/trunk |
a81ed0b6 EW |
534 | # Enter the newly cloned directory: |
535 | cd trunk | |
536 | # You should be on master branch, double-check with git-branch | |
537 | git branch | |
538 | # Do some work and commit locally to git: | |
539 | git commit ... | |
540 | # Something is committed to SVN, rebase your local changes against the | |
541 | # latest changes in SVN: | |
b1889c36 | 542 | git svn rebase |
a81ed0b6 EW |
543 | # Now commit your changes (that were committed previously using git) to SVN, |
544 | # as well as automatically updating your working HEAD: | |
b1889c36 | 545 | git svn dcommit |
20b1d700 | 546 | # Append svn:ignore settings to the default git exclude file: |
b1889c36 | 547 | git svn show-ignore >> .git/info/exclude |
20b1d700 | 548 | ------------------------------------------------------------------------ |
3397f9df | 549 | |
0d313b2b EW |
550 | Tracking and contributing to an entire Subversion-managed project |
551 | (complete with a trunk, tags and branches): | |
0d313b2b EW |
552 | |
553 | ------------------------------------------------------------------------ | |
a81ed0b6 | 554 | # Clone a repo (like git clone): |
2670ddce | 555 | git svn clone http://svn.example.com/project -T trunk -b branches -t tags |
a81ed0b6 EW |
556 | # View all branches and tags you have cloned: |
557 | git branch -r | |
5de70efb FR |
558 | # Create a new branch in SVN |
559 | git svn branch waldo | |
a81ed0b6 EW |
560 | # Reset your master to trunk (or any other branch, replacing 'trunk' |
561 | # with the appropriate name): | |
562 | git reset --hard remotes/trunk | |
563 | # You may only dcommit to one branch/tag/trunk at a time. The usage | |
20f50f16 | 564 | # of dcommit/rebase/show-ignore should be the same as above. |
0d313b2b EW |
565 | ------------------------------------------------------------------------ |
566 | ||
ba020ef5 | 567 | The initial 'git-svn clone' can be quite time-consuming |
7d4aef40 AR |
568 | (especially for large Subversion repositories). If multiple |
569 | people (or one person with multiple machines) want to use | |
ba020ef5 JN |
570 | 'git-svn' to interact with the same Subversion repository, you can |
571 | do the initial 'git-svn clone' to a repository on a server and | |
572 | have each person clone that repository with 'git-clone': | |
7d4aef40 AR |
573 | |
574 | ------------------------------------------------------------------------ | |
575 | # Do the initial import on a server | |
2670ddce | 576 | ssh server "cd /pub && git svn clone http://svn.example.com/project |
2b0d1033 SV |
577 | # Clone locally - make sure the refs/remotes/ space matches the server |
578 | mkdir project | |
579 | cd project | |
b1889c36 | 580 | git init |
2b0d1033 | 581 | git remote add origin server:/pub/project |
762656e0 | 582 | git config --add remote.origin.fetch '+refs/remotes/*:refs/remotes/*' |
2b0d1033 | 583 | git fetch |
9e77353e JK |
584 | # Create a local branch from one of the branches just fetched |
585 | git checkout -b master FETCH_HEAD | |
7d4aef40 | 586 | # Initialize git-svn locally (be sure to use the same URL and -T/-b/-t options as were used on server) |
2670ddce | 587 | git svn init http://svn.example.com/project |
7d4aef40 | 588 | # Pull the latest changes from Subversion |
b1889c36 | 589 | git svn rebase |
7d4aef40 AR |
590 | ------------------------------------------------------------------------ |
591 | ||
2eff1425 EW |
592 | REBASE VS. PULL/MERGE |
593 | --------------------- | |
2e93115e | 594 | |
ba020ef5 | 595 | Originally, 'git-svn' recommended that the 'remotes/git-svn' branch be |
2eff1425 | 596 | pulled or merged from. This is because the author favored |
483bc4f0 JN |
597 | `git svn set-tree B` to commit a single head rather than the |
598 | `git svn set-tree A..B` notation to commit multiple commits. | |
2eff1425 | 599 | |
483bc4f0 | 600 | If you use `git svn set-tree A..B` to commit several diffs and you do |
2eff1425 | 601 | not have the latest remotes/git-svn merged into my-branch, you should |
483bc4f0 JN |
602 | use `git svn rebase` to update your work branch instead of `git pull` or |
603 | `git merge`. `pull`/`merge' can cause non-linear history to be flattened | |
2eff1425 EW |
604 | when committing into SVN, which can lead to merge commits reversing |
605 | previous commits in SVN. | |
2e93115e | 606 | |
3397f9df EW |
607 | DESIGN PHILOSOPHY |
608 | ----------------- | |
609 | Merge tracking in Subversion is lacking and doing branched development | |
ba020ef5 | 610 | with Subversion can be cumbersome as a result. While 'git-svn' can track |
bd43098c EW |
611 | copy history (including branches and tags) for repositories adopting a |
612 | standard layout, it cannot yet represent merge history that happened | |
613 | inside git back upstream to SVN users. Therefore it is advised that | |
614 | users keep history as linear as possible inside git to ease | |
615 | compatibility with SVN (see the CAVEATS section below). | |
1d52aba8 | 616 | |
aabb2e51 EW |
617 | CAVEATS |
618 | ------- | |
619 | ||
620 | For the sake of simplicity and interoperating with a less-capable system | |
ba020ef5 | 621 | (SVN), it is recommended that all 'git-svn' users clone, fetch and dcommit |
5833d730 | 622 | directly from the SVN server, and avoid all 'git-clone'/'pull'/'merge'/'push' |
aabb2e51 EW |
623 | operations between git repositories and branches. The recommended |
624 | method of exchanging code between git branches and users is | |
ba020ef5 | 625 | 'git-format-patch' and 'git-am', or just 'dcommit'ing to the SVN repository. |
aabb2e51 | 626 | |
ba020ef5 | 627 | Running 'git-merge' or 'git-pull' is NOT recommended on a branch you |
483bc4f0 | 628 | plan to 'dcommit' from. Subversion does not represent merges in any |
aabb2e51 EW |
629 | reasonable or useful fashion; so users using Subversion cannot see any |
630 | merges you've made. Furthermore, if you merge or pull from a git branch | |
483bc4f0 | 631 | that is a mirror of an SVN branch, 'dcommit' may commit to the wrong |
aabb2e51 EW |
632 | branch. |
633 | ||
ba020ef5 JN |
634 | 'git-clone' does not clone branches under the refs/remotes/ hierarchy or |
635 | any 'git-svn' metadata, or config. So repositories created and managed with | |
2fd02c92 | 636 | using 'git-svn' should use 'rsync' for cloning, if cloning is to be done |
aabb2e51 EW |
637 | at all. |
638 | ||
ba020ef5 | 639 | Since 'dcommit' uses rebase internally, any git branches you 'git-push' to |
483bc4f0 | 640 | before 'dcommit' on will require forcing an overwrite of the existing ref |
aabb2e51 | 641 | on the remote repository. This is generally considered bad practice, |
483bc4f0 | 642 | see the linkgit:git-push[1] documentation for details. |
aabb2e51 | 643 | |
483bc4f0 | 644 | Do not use the --amend option of linkgit:git-commit[1] on a change you've |
aabb2e51 EW |
645 | already dcommitted. It is considered bad practice to --amend commits |
646 | you've already pushed to a remote repository for other users, and | |
647 | dcommit with SVN is analogous to that. | |
648 | ||
3397f9df EW |
649 | BUGS |
650 | ---- | |
e8f5d908 | 651 | |
a81ed0b6 EW |
652 | We ignore all SVN properties except svn:executable. Any unhandled |
653 | properties are logged to $GIT_DIR/svn/<refname>/unhandled.log | |
3397f9df | 654 | |
bbe0c9b8 EW |
655 | Renamed and copied directories are not detected by git and hence not |
656 | tracked when committing to SVN. I do not plan on adding support for | |
657 | this as it's quite difficult and time-consuming to get working for all | |
a81ed0b6 EW |
658 | the possible corner cases (git doesn't do it, either). Committing |
659 | renamed and copied files are fully supported if they're similar enough | |
660 | for git to detect them. | |
bbe0c9b8 | 661 | |
a836a0e1 EW |
662 | CONFIGURATION |
663 | ------------- | |
664 | ||
ba020ef5 | 665 | 'git-svn' stores [svn-remote] configuration information in the |
a836a0e1 EW |
666 | repository .git/config file. It is similar the core git |
667 | [remote] sections except 'fetch' keys do not accept glob | |
668 | arguments; but they are instead handled by the 'branches' | |
669 | and 'tags' keys. Since some SVN repositories are oddly | |
670 | configured with multiple projects glob expansions such those | |
671 | listed below are allowed: | |
672 | ||
673 | ------------------------------------------------------------------------ | |
674 | [svn-remote "project-a"] | |
675 | url = http://server.org/svn | |
676 | branches = branches/*/project-a:refs/remotes/project-a/branches/* | |
677 | tags = tags/*/project-a:refs/remotes/project-a/tags/* | |
678 | trunk = trunk/project-a:refs/remotes/project-a/trunk | |
679 | ------------------------------------------------------------------------ | |
680 | ||
681 | Keep in mind that the '*' (asterisk) wildcard of the local ref | |
d37a8de0 | 682 | (right of the ':') *must* be the farthest right path component; |
a836a0e1 | 683 | however the remote wildcard may be anywhere as long as it's own |
02783075 | 684 | independent path component (surrounded by '/' or EOL). This |
a836a0e1 | 685 | type of configuration is not automatically created by 'init' and |
ba020ef5 | 686 | should be manually entered with a text-editor or using 'git-config'. |
a836a0e1 | 687 | |
2e93115e EW |
688 | SEE ALSO |
689 | -------- | |
5162e697 | 690 | linkgit:git-rebase[1] |
2e93115e | 691 | |
3397f9df EW |
692 | Author |
693 | ------ | |
694 | Written by Eric Wong <normalperson@yhbt.net>. | |
695 | ||
696 | Documentation | |
697 | ------------- | |
698 | Written by Eric Wong <normalperson@yhbt.net>. |