Documentation / git-svn.txton commit Merge branch 'mk/grep-pcre' (13b70d2)
   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        This option is not recommended, please read the 'svn.noMetadata'
  60        section of this manpage before using this option.
  61--use-svm-props;;
  62        Set the 'useSvmProps' option in the [svn-remote] config.
  63--use-svnsync-props;;
  64        Set the 'useSvnsyncProps' option in the [svn-remote] config.
  65--rewrite-root=<URL>;;
  66        Set the 'rewriteRoot' option in the [svn-remote] config.
  67--rewrite-uuid=<UUID>;;
  68        Set the 'rewriteUUID' option in the [svn-remote] config.
  69--username=<user>;;
  70        For transports that SVN handles authentication for (http,
  71        https, and plain svn), specify the username.  For other
  72        transports (eg svn+ssh://), you must include the username in
  73        the URL, eg svn+ssh://foo@svn.bar.com/project
  74--prefix=<prefix>;;
  75        This allows one to specify a prefix which is prepended
  76        to the names of remotes if trunk/branches/tags are
  77        specified.  The prefix does not automatically include a
  78        trailing slash, so be sure you include one in the
  79        argument if that is what you want.  If --branches/-b is
  80        specified, the prefix must include a trailing slash.
  81        Setting a prefix is useful if you wish to track multiple
  82        projects that share a common repository.
  83--ignore-paths=<regex>;;
  84        When passed to 'init' or 'clone' this regular expression will
  85        be preserved as a config key.  See 'fetch' for a description
  86        of '--ignore-paths'.
  87--no-minimize-url;;
  88        When tracking multiple directories (using --stdlayout,
  89        --branches, or --tags options), git svn will attempt to connect
  90        to the root (or highest allowed level) of the Subversion
  91        repository.  This default allows better tracking of history if
  92        entire projects are moved within a repository, but may cause
  93        issues on repositories where read access restrictions are in
  94        place.  Passing '--no-minimize-url' will allow git svn to
  95        accept URLs as-is without attempting to connect to a higher
  96        level directory.  This option is off by default when only
  97        one URL/branch is tracked (it would do little good).
  98
  99'fetch'::
 100        Fetch unfetched revisions from the Subversion remote we are
 101        tracking.  The name of the [svn-remote "..."] section in the
 102        .git/config file may be specified as an optional command-line
 103        argument.
 104
 105--localtime;;
 106        Store Git commit times in the local timezone instead of UTC.  This
 107        makes 'git log' (even without --date=local) show the same times
 108        that `svn log` would in the local timezone.
 109+
 110This doesn't interfere with interoperating with the Subversion
 111repository you cloned from, but if you wish for your local Git
 112repository to be able to interoperate with someone else's local Git
 113repository, either don't use this option or you should both use it in
 114the same local timezone.
 115
 116--parent;;
 117        Fetch only from the SVN parent of the current HEAD.
 118
 119--ignore-paths=<regex>;;
 120        This allows one to specify a Perl regular expression that will
 121        cause skipping of all matching paths from checkout from SVN.
 122        The '--ignore-paths' option should match for every 'fetch'
 123        (including automatic fetches due to 'clone', 'dcommit',
 124        'rebase', etc) on a given repository.
 125+
 126[verse]
 127config key: svn-remote.<name>.ignore-paths
 128+
 129If the ignore-paths config key is set and the command line option is
 130also given, both regular expressions will be used.
 131+
 132Examples:
 133+
 134--
 135Skip "doc*" directory for every fetch;;
 136+
 137------------------------------------------------------------------------
 138--ignore-paths="^doc"
 139------------------------------------------------------------------------
 140
 141Skip "branches" and "tags" of first level directories;;
 142+
 143------------------------------------------------------------------------
 144--ignore-paths="^[^/]+/(?:branches|tags)"
 145------------------------------------------------------------------------
 146--
 147
 148'clone'::
 149        Runs 'init' and 'fetch'.  It will automatically create a
 150        directory based on the basename of the URL passed to it;
 151        or if a second argument is passed; it will create a directory
 152        and work within that.  It accepts all arguments that the
 153        'init' and 'fetch' commands accept; with the exception of
 154        '--fetch-all' and '--parent'.  After a repository is cloned,
 155        the 'fetch' command will be able to update revisions without
 156        affecting the working tree; and the 'rebase' command will be
 157        able to update the working tree with the latest changes.
 158
 159'rebase'::
 160        This fetches revisions from the SVN parent of the current HEAD
 161        and rebases the current (uncommitted to SVN) work against it.
 162+
 163This works similarly to `svn update` or 'git pull' except that
 164it preserves linear history with 'git rebase' instead of
 165'git merge' for ease of dcommitting with 'git svn'.
 166+
 167This accepts all options that 'git svn fetch' and 'git rebase'
 168accept.  However, '--fetch-all' only fetches from the current
 169[svn-remote], and not all [svn-remote] definitions.
 170+
 171Like 'git rebase'; this requires that the working tree be clean
 172and have no uncommitted changes.
 173
 174-l;;
 175--local;;
 176        Do not fetch remotely; only run 'git rebase' against the
 177        last fetched commit from the upstream SVN.
 178
 179'dcommit'::
 180        Commit each diff from a specified head directly to the SVN
 181        repository, and then rebase or reset (depending on whether or
 182        not there is a diff between SVN and head).  This will create
 183        a revision in SVN for each commit in git.
 184        It is recommended that you run 'git svn' fetch and rebase (not
 185        pull or merge) your commits against the latest changes in the
 186        SVN repository.
 187        An optional revision or branch argument may be specified, and
 188        causes 'git svn' to do all work on that revision/branch
 189        instead of HEAD.
 190        This is advantageous over 'set-tree' (below) because it produces
 191        cleaner, more linear history.
 192+
 193--no-rebase;;
 194        After committing, do not rebase or reset.
 195--commit-url <URL>;;
 196        Commit to this SVN URL (the full path).  This is intended to
 197        allow existing 'git svn' repositories created with one transport
 198        method (e.g. `svn://` or `http://` for anonymous read) to be
 199        reused if a user is later given access to an alternate transport
 200        method (e.g. `svn+ssh://` or `https://`) for commit.
 201+
 202[verse]
 203config key: svn-remote.<name>.commiturl
 204config key: svn.commiturl (overwrites all svn-remote.<name>.commiturl options)
 205+
 206Using this option for any other purpose (don't ask) is very strongly
 207discouraged.
 208
 209--mergeinfo=<mergeinfo>;;
 210        Add the given merge information during the dcommit
 211        (e.g. `--mergeinfo="/branches/foo:1-10"`). All svn server versions can
 212        store this information (as a property), and svn clients starting from
 213        version 1.5 can make use of it. 'git svn' currently does not use it
 214        and does not set it automatically.
 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        the 'username' configuration property.
 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        (See the svn-remote.<name>.automkdirs config file option for
 343        more information.)
 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--use-log-author::
 567        When retrieving svn commits into git (as part of 'fetch', 'rebase', or
 568        'dcommit' operations), look for the first `From:` or `Signed-off-by:` line
 569        in the log message and use that as the author string.
 570--add-author-from::
 571        When committing to svn from git (as part of 'commit-diff', 'set-tree' or 'dcommit'
 572        operations), if the existing log message doesn't already have a
 573        `From:` or `Signed-off-by:` line, append a `From:` line based on the
 574        git commit's author string.  If you use this, then `--use-log-author`
 575        will retrieve a valid author string for all commits.
 576
 577
 578ADVANCED OPTIONS
 579----------------
 580
 581-i<GIT_SVN_ID>::
 582--id <GIT_SVN_ID>::
 583        This sets GIT_SVN_ID (instead of using the environment).  This
 584        allows the user to override the default refname to fetch from
 585        when tracking a single URL.  The 'log' and 'dcommit' commands
 586        no longer require this switch as an argument.
 587
 588-R<remote name>::
 589--svn-remote <remote name>::
 590        Specify the [svn-remote "<remote name>"] section to use,
 591        this allows SVN multiple repositories to be tracked.
 592        Default: "svn"
 593
 594--follow-parent::
 595        This is especially helpful when we're tracking a directory
 596        that has been moved around within the repository, or if we
 597        started tracking a branch and never tracked the trunk it was
 598        descended from. This feature is enabled by default, use
 599        --no-follow-parent to disable it.
 600+
 601[verse]
 602config key: svn.followparent
 603
 604CONFIG FILE-ONLY OPTIONS
 605------------------------
 606
 607svn.noMetadata::
 608svn-remote.<name>.noMetadata::
 609        This gets rid of the 'git-svn-id:' lines at the end of every commit.
 610+
 611This option can only be used for one-shot imports as 'git svn'
 612will not be able to fetch again without metadata. Additionally,
 613if you lose your .git/svn/**/.rev_map.* files, 'git svn' will not
 614be able to rebuild them.
 615+
 616The 'git svn log' command will not work on repositories using
 617this, either.  Using this conflicts with the 'useSvmProps'
 618option for (hopefully) obvious reasons.
 619+
 620This option is NOT recommended as it makes it difficult to track down
 621old references to SVN revision numbers in existing documentation, bug
 622reports and archives.  If you plan to eventually migrate from SVN to git
 623and are certain about dropping SVN history, consider
 624linkgit:git-filter-branch[1] instead.  filter-branch also allows
 625reformatting of metadata for ease-of-reading and rewriting authorship
 626info for non-"svn.authorsFile" users.
 627
 628svn.useSvmProps::
 629svn-remote.<name>.useSvmProps::
 630        This allows 'git svn' to re-map repository URLs and UUIDs from
 631        mirrors created using SVN::Mirror (or svk) for metadata.
 632+
 633If an SVN revision has a property, "svm:headrev", it is likely
 634that the revision was created by SVN::Mirror (also used by SVK).
 635The property contains a repository UUID and a revision.  We want
 636to make it look like we are mirroring the original URL, so
 637introduce a helper function that returns the original identity
 638URL and UUID, and use it when generating metadata in commit
 639messages.
 640
 641svn.useSvnsyncProps::
 642svn-remote.<name>.useSvnsyncprops::
 643        Similar to the useSvmProps option; this is for users
 644        of the svnsync(1) command distributed with SVN 1.4.x and
 645        later.
 646
 647svn-remote.<name>.rewriteRoot::
 648        This allows users to create repositories from alternate
 649        URLs.  For example, an administrator could run 'git svn' on the
 650        server locally (accessing via file://) but wish to distribute
 651        the repository with a public http:// or svn:// URL in the
 652        metadata so users of it will see the public URL.
 653
 654svn-remote.<name>.rewriteUUID::
 655        Similar to the useSvmProps option; this is for users who need
 656        to remap the UUID manually. This may be useful in situations
 657        where the original UUID is not available via either useSvmProps
 658        or useSvnsyncProps.
 659
 660svn-remote.<name>.pushurl::
 661
 662        Similar to git's 'remote.<name>.pushurl', this key is designed
 663        to be used in cases where 'url' points to an SVN repository
 664        via a read-only transport, to provide an alternate read/write
 665        transport. It is assumed that both keys point to the same
 666        repository. Unlike 'commiturl', 'pushurl' is a base path. If
 667        either 'commiturl' or 'pushurl' could be used, 'commiturl'
 668        takes precedence.
 669
 670svn.brokenSymlinkWorkaround::
 671        This disables potentially expensive checks to workaround
 672        broken symlinks checked into SVN by broken clients.  Set this
 673        option to "false" if you track a SVN repository with many
 674        empty blobs that are not symlinks.  This option may be changed
 675        while 'git svn' is running and take effect on the next
 676        revision fetched.  If unset, 'git svn' assumes this option to
 677        be "true".
 678
 679svn.pathnameencoding::
 680        This instructs git svn to recode pathnames to a given encoding.
 681        It can be used by windows users and by those who work in non-utf8
 682        locales to avoid corrupted file names with non-ASCII characters.
 683        Valid encodings are the ones supported by Perl's Encode module.
 684
 685svn-remote.<name>.automkdirs::
 686        Normally, the "git svn clone" and "git svn rebase" commands
 687        attempt to recreate empty directories that are in the
 688        Subversion repository.  If this option is set to "false", then
 689        empty directories will only be created if the "git svn mkdirs"
 690        command is run explicitly.  If unset, 'git svn' assumes this
 691        option to be "true".
 692
 693Since the noMetadata, rewriteRoot, rewriteUUID, useSvnsyncProps and useSvmProps
 694options all affect the metadata generated and used by 'git svn'; they
 695*must* be set in the configuration file before any history is imported
 696and these settings should never be changed once they are set.
 697
 698Additionally, only one of these options can be used per svn-remote
 699section because they affect the 'git-svn-id:' metadata line, except
 700for rewriteRoot and rewriteUUID which can be used together.
 701
 702
 703BASIC EXAMPLES
 704--------------
 705
 706Tracking and contributing to the trunk of a Subversion-managed project:
 707
 708------------------------------------------------------------------------
 709# Clone a repo (like git clone):
 710        git svn clone http://svn.example.com/project/trunk
 711# Enter the newly cloned directory:
 712        cd trunk
 713# You should be on master branch, double-check with 'git branch'
 714        git branch
 715# Do some work and commit locally to git:
 716        git commit ...
 717# Something is committed to SVN, rebase your local changes against the
 718# latest changes in SVN:
 719        git svn rebase
 720# Now commit your changes (that were committed previously using git) to SVN,
 721# as well as automatically updating your working HEAD:
 722        git svn dcommit
 723# Append svn:ignore settings to the default git exclude file:
 724        git svn show-ignore >> .git/info/exclude
 725------------------------------------------------------------------------
 726
 727Tracking and contributing to an entire Subversion-managed project
 728(complete with a trunk, tags and branches):
 729
 730------------------------------------------------------------------------
 731# Clone a repo (like git clone):
 732        git svn clone http://svn.example.com/project -T trunk -b branches -t tags
 733# View all branches and tags you have cloned:
 734        git branch -r
 735# Create a new branch in SVN
 736    git svn branch waldo
 737# Reset your master to trunk (or any other branch, replacing 'trunk'
 738# with the appropriate name):
 739        git reset --hard remotes/trunk
 740# You may only dcommit to one branch/tag/trunk at a time.  The usage
 741# of dcommit/rebase/show-ignore should be the same as above.
 742------------------------------------------------------------------------
 743
 744The initial 'git svn clone' can be quite time-consuming
 745(especially for large Subversion repositories). If multiple
 746people (or one person with multiple machines) want to use
 747'git svn' to interact with the same Subversion repository, you can
 748do the initial 'git svn clone' to a repository on a server and
 749have each person clone that repository with 'git clone':
 750
 751------------------------------------------------------------------------
 752# Do the initial import on a server
 753        ssh server "cd /pub && git svn clone http://svn.example.com/project
 754# Clone locally - make sure the refs/remotes/ space matches the server
 755        mkdir project
 756        cd project
 757        git init
 758        git remote add origin server:/pub/project
 759        git config --replace-all remote.origin.fetch '+refs/remotes/*:refs/remotes/*'
 760        git fetch
 761# Prevent fetch/pull from remote git server in the future,
 762# we only want to use git svn for future updates
 763        git config --remove-section remote.origin
 764# Create a local branch from one of the branches just fetched
 765        git checkout -b master FETCH_HEAD
 766# Initialize 'git svn' locally (be sure to use the same URL and -T/-b/-t options as were used on server)
 767        git svn init http://svn.example.com/project
 768# Pull the latest changes from Subversion
 769        git svn rebase
 770------------------------------------------------------------------------
 771
 772REBASE VS. PULL/MERGE
 773---------------------
 774
 775Originally, 'git svn' recommended that the 'remotes/git-svn' branch be
 776pulled or merged from.  This is because the author favored
 777`git svn set-tree B` to commit a single head rather than the
 778`git svn set-tree A..B` notation to commit multiple commits.
 779
 780If you use `git svn set-tree A..B` to commit several diffs and you do
 781not have the latest remotes/git-svn merged into my-branch, you should
 782use `git svn rebase` to update your work branch instead of `git pull` or
 783`git merge`.  `pull`/`merge` can cause non-linear history to be flattened
 784when committing into SVN, which can lead to merge commits reversing
 785previous commits in SVN.
 786
 787MERGE TRACKING
 788--------------
 789While 'git svn' can track
 790copy history (including branches and tags) for repositories adopting a
 791standard layout, it cannot yet represent merge history that happened
 792inside git back upstream to SVN users.  Therefore it is advised that
 793users keep history as linear as possible inside git to ease
 794compatibility with SVN (see the CAVEATS section below).
 795
 796CAVEATS
 797-------
 798
 799For the sake of simplicity and interoperating with Subversion,
 800it is recommended that all 'git svn' users clone, fetch and dcommit
 801directly from the SVN server, and avoid all 'git clone'/'pull'/'merge'/'push'
 802operations between git repositories and branches.  The recommended
 803method of exchanging code between git branches and users is
 804'git format-patch' and 'git am', or just 'dcommit'ing to the SVN repository.
 805
 806Running 'git merge' or 'git pull' is NOT recommended on a branch you
 807plan to 'dcommit' from because Subversion users cannot see any
 808merges you've made.  Furthermore, if you merge or pull from a git branch
 809that is a mirror of an SVN branch, 'dcommit' may commit to the wrong
 810branch.
 811
 812If you do merge, note the following rule: 'git svn dcommit' will
 813attempt to commit on top of the SVN commit named in
 814------------------------------------------------------------------------
 815git log --grep=^git-svn-id: --first-parent -1
 816------------------------------------------------------------------------
 817You 'must' therefore ensure that the most recent commit of the branch
 818you want to dcommit to is the 'first' parent of the merge.  Chaos will
 819ensue otherwise, especially if the first parent is an older commit on
 820the same SVN branch.
 821
 822'git clone' does not clone branches under the refs/remotes/ hierarchy or
 823any 'git svn' metadata, or config.  So repositories created and managed with
 824using 'git svn' should use 'rsync' for cloning, if cloning is to be done
 825at all.
 826
 827Since 'dcommit' uses rebase internally, any git branches you 'git push' to
 828before 'dcommit' on will require forcing an overwrite of the existing ref
 829on the remote repository.  This is generally considered bad practice,
 830see the linkgit:git-push[1] documentation for details.
 831
 832Do not use the --amend option of linkgit:git-commit[1] on a change you've
 833already dcommitted.  It is considered bad practice to --amend commits
 834you've already pushed to a remote repository for other users, and
 835dcommit with SVN is analogous to that.
 836
 837When using multiple --branches or --tags, 'git svn' does not automatically
 838handle name collisions (for example, if two branches from different paths have
 839the same name, or if a branch and a tag have the same name).  In these cases,
 840use 'init' to set up your git repository then, before your first 'fetch', edit
 841the .git/config file so that the branches and tags are associated with
 842different name spaces.  For example:
 843
 844        branches = stable/*:refs/remotes/svn/stable/*
 845        branches = debug/*:refs/remotes/svn/debug/*
 846
 847BUGS
 848----
 849
 850We ignore all SVN properties except svn:executable.  Any unhandled
 851properties are logged to $GIT_DIR/svn/<refname>/unhandled.log
 852
 853Renamed and copied directories are not detected by git and hence not
 854tracked when committing to SVN.  I do not plan on adding support for
 855this as it's quite difficult and time-consuming to get working for all
 856the possible corner cases (git doesn't do it, either).  Committing
 857renamed and copied files is fully supported if they're similar enough
 858for git to detect them.
 859
 860CONFIGURATION
 861-------------
 862
 863'git svn' stores [svn-remote] configuration information in the
 864repository .git/config file.  It is similar the core git
 865[remote] sections except 'fetch' keys do not accept glob
 866arguments; but they are instead handled by the 'branches'
 867and 'tags' keys.  Since some SVN repositories are oddly
 868configured with multiple projects glob expansions such those
 869listed below are allowed:
 870
 871------------------------------------------------------------------------
 872[svn-remote "project-a"]
 873        url = http://server.org/svn
 874        fetch = trunk/project-a:refs/remotes/project-a/trunk
 875        branches = branches/*/project-a:refs/remotes/project-a/branches/*
 876        tags = tags/*/project-a:refs/remotes/project-a/tags/*
 877------------------------------------------------------------------------
 878
 879Keep in mind that the '\*' (asterisk) wildcard of the local ref
 880(right of the ':') *must* be the farthest right path component;
 881however the remote wildcard may be anywhere as long as it's an
 882independent path component (surrounded by '/' or EOL).   This
 883type of configuration is not automatically created by 'init' and
 884should be manually entered with a text-editor or using 'git config'.
 885
 886It is also possible to fetch a subset of branches or tags by using a
 887comma-separated list of names within braces. For example:
 888
 889------------------------------------------------------------------------
 890[svn-remote "huge-project"]
 891        url = http://server.org/svn
 892        fetch = trunk/src:refs/remotes/trunk
 893        branches = branches/{red,green}/src:refs/remotes/branches/*
 894        tags = tags/{1.0,2.0}/src:refs/remotes/tags/*
 895------------------------------------------------------------------------
 896
 897Note that git-svn keeps track of the highest revision in which a branch
 898or tag has appeared. If the subset of branches or tags is changed after
 899fetching, then .git/svn/.metadata must be manually edited to remove (or
 900reset) branches-maxRev and/or tags-maxRev as appropriate.
 901
 902SEE ALSO
 903--------
 904linkgit:git-rebase[1]
 905
 906GIT
 907---
 908Part of the linkgit:git[1] suite