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