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