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