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