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