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