Documentation / git-svn.txton commit pager: remove 'S' from $LESS by default (b327583)
   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 (with a trailing slash) is strongly
  83        encouraged in any case, as your SVN-tracking refs will
  84        then be located at "refs/remotes/$prefix/*", which is
  85        compatible with Git's own remote-tracking ref layout
  86        (refs/remotes/$remote/*). Setting a prefix is also useful
  87        if you wish to track multiple projects that share a common
  88        repository.
  89        By default, the prefix is set to 'origin/'.
  90+
  91NOTE: Before Git v2.0, the default prefix was "" (no prefix). This
  92meant that SVN-tracking refs were put at "refs/remotes/*", which is
  93incompatible with how Git's own remote-tracking refs are organized.
  94
  95--ignore-paths=<regex>;;
  96        When passed to 'init' or 'clone' this regular expression will
  97        be preserved as a config key.  See 'fetch' for a description
  98        of '--ignore-paths'.
  99--include-paths=<regex>;;
 100        When passed to 'init' or 'clone' this regular expression will
 101        be preserved as a config key.  See 'fetch' for a description
 102        of '--include-paths'.
 103--no-minimize-url;;
 104        When tracking multiple directories (using --stdlayout,
 105        --branches, or --tags options), git svn will attempt to connect
 106        to the root (or highest allowed level) of the Subversion
 107        repository.  This default allows better tracking of history if
 108        entire projects are moved within a repository, but may cause
 109        issues on repositories where read access restrictions are in
 110        place.  Passing '--no-minimize-url' will allow git svn to
 111        accept URLs as-is without attempting to connect to a higher
 112        level directory.  This option is off by default when only
 113        one URL/branch is tracked (it would do little good).
 114
 115'fetch'::
 116        Fetch unfetched revisions from the Subversion remote we are
 117        tracking.  The name of the [svn-remote "..."] section in the
 118        $GIT_DIR/config file may be specified as an optional
 119        command-line argument.
 120+
 121This automatically updates the rev_map if needed (see
 122'$GIT_DIR/svn/\*\*/.rev_map.*' in the FILES section below for details).
 123
 124--localtime;;
 125        Store Git commit times in the local time zone instead of UTC.  This
 126        makes 'git log' (even without --date=local) show the same times
 127        that `svn log` would in the local time zone.
 128+
 129This doesn't interfere with interoperating with the Subversion
 130repository you cloned from, but if you wish for your local Git
 131repository to be able to interoperate with someone else's local Git
 132repository, either don't use this option or you should both use it in
 133the same local time zone.
 134
 135--parent;;
 136        Fetch only from the SVN parent of the current HEAD.
 137
 138--ignore-paths=<regex>;;
 139        This allows one to specify a Perl regular expression that will
 140        cause skipping of all matching paths from checkout from SVN.
 141        The '--ignore-paths' option should match for every 'fetch'
 142        (including automatic fetches due to 'clone', 'dcommit',
 143        'rebase', etc) on a given repository.
 144+
 145[verse]
 146config key: svn-remote.<name>.ignore-paths
 147+
 148If the ignore-paths config key is set and the command line option is
 149also given, both regular expressions will be used.
 150+
 151Examples:
 152+
 153--
 154Skip "doc*" directory for every fetch;;
 155+
 156------------------------------------------------------------------------
 157--ignore-paths="^doc"
 158------------------------------------------------------------------------
 159
 160Skip "branches" and "tags" of first level directories;;
 161+
 162------------------------------------------------------------------------
 163--ignore-paths="^[^/]+/(?:branches|tags)"
 164------------------------------------------------------------------------
 165--
 166
 167--include-paths=<regex>;;
 168        This allows one to specify a Perl regular expression that will
 169        cause the inclusion of only matching paths from checkout from SVN.
 170        The '--include-paths' option should match for every 'fetch'
 171        (including automatic fetches due to 'clone', 'dcommit',
 172        'rebase', etc) on a given repository. '--ignore-paths' takes
 173        precedence over '--include-paths'.
 174
 175--log-window-size=<n>;;
 176        Fetch <n> log entries per request when scanning Subversion history.
 177        The default is 100. For very large Subversion repositories, larger
 178        values may be needed for 'clone'/'fetch' to complete in reasonable
 179        time. But overly large values may lead to higher memory usage and
 180        request timeouts.
 181
 182'clone'::
 183        Runs 'init' and 'fetch'.  It will automatically create a
 184        directory based on the basename of the URL passed to it;
 185        or if a second argument is passed; it will create a directory
 186        and work within that.  It accepts all arguments that the
 187        'init' and 'fetch' commands accept; with the exception of
 188        '--fetch-all' and '--parent'.  After a repository is cloned,
 189        the 'fetch' command will be able to update revisions without
 190        affecting the working tree; and the 'rebase' command will be
 191        able to update the working tree with the latest changes.
 192
 193--preserve-empty-dirs;;
 194        Create a placeholder file in the local Git repository for each
 195        empty directory fetched from Subversion.  This includes directories
 196        that become empty by removing all entries in the Subversion
 197        repository (but not the directory itself).  The placeholder files
 198        are also tracked and removed when no longer necessary.
 199
 200--placeholder-filename=<filename>;;
 201        Set the name of placeholder files created by --preserve-empty-dirs.
 202        Default: ".gitignore"
 203
 204'rebase'::
 205        This fetches revisions from the SVN parent of the current HEAD
 206        and rebases the current (uncommitted to SVN) work against it.
 207+
 208This works similarly to `svn update` or 'git pull' except that
 209it preserves linear history with 'git rebase' instead of
 210'git merge' for ease of dcommitting with 'git svn'.
 211+
 212This accepts all options that 'git svn fetch' and 'git rebase'
 213accept.  However, '--fetch-all' only fetches from the current
 214[svn-remote], and not all [svn-remote] definitions.
 215+
 216Like 'git rebase'; this requires that the working tree be clean
 217and have no uncommitted changes.
 218+
 219This automatically updates the rev_map if needed (see
 220'$GIT_DIR/svn/\*\*/.rev_map.*' in the FILES section below for details).
 221
 222-l;;
 223--local;;
 224        Do not fetch remotely; only run 'git rebase' against the
 225        last fetched commit from the upstream SVN.
 226
 227'dcommit'::
 228        Commit each diff from the current branch directly to the SVN
 229        repository, and then rebase or reset (depending on whether or
 230        not there is a diff between SVN and head).  This will create
 231        a revision in SVN for each commit in Git.
 232+
 233When an optional Git branch name (or a Git commit object name)
 234is specified as an argument, the subcommand works on the specified
 235branch, not on the current branch.
 236+
 237Use of 'dcommit' is preferred to 'set-tree' (below).
 238+
 239--no-rebase;;
 240        After committing, do not rebase or reset.
 241--commit-url <URL>;;
 242        Commit to this SVN URL (the full path).  This is intended to
 243        allow existing 'git svn' repositories created with one transport
 244        method (e.g. `svn://` or `http://` for anonymous read) to be
 245        reused if a user is later given access to an alternate transport
 246        method (e.g. `svn+ssh://` or `https://`) for commit.
 247+
 248[verse]
 249config key: svn-remote.<name>.commiturl
 250config key: svn.commiturl (overwrites all svn-remote.<name>.commiturl options)
 251+
 252Using this option for any other purpose (don't ask) is very strongly
 253discouraged.
 254
 255--mergeinfo=<mergeinfo>;;
 256        Add the given merge information during the dcommit
 257        (e.g. `--mergeinfo="/branches/foo:1-10"`). All svn server versions can
 258        store this information (as a property), and svn clients starting from
 259        version 1.5 can make use of it. To specify merge information from multiple
 260        branches, use a single space character between the branches
 261        (`--mergeinfo="/branches/foo:1-10 /branches/bar:3,5-6,8"`)
 262+
 263[verse]
 264config key: svn.pushmergeinfo
 265+
 266This option will cause git-svn to attempt to automatically populate the
 267svn:mergeinfo property in the SVN repository when possible. Currently, this can
 268only be done when dcommitting non-fast-forward merges where all parents but the
 269first have already been pushed into SVN.
 270
 271--interactive;;
 272        Ask the user to confirm that a patch set should actually be sent to SVN.
 273        For each patch, one may answer "yes" (accept this patch), "no" (discard this
 274        patch), "all" (accept all patches), or "quit".
 275        +
 276        'git svn dcommit' returns immediately if answer is "no" or "quit", without
 277        committing anything to SVN.
 278
 279'branch'::
 280        Create a branch in the SVN repository.
 281
 282-m;;
 283--message;;
 284        Allows to specify the commit message.
 285
 286-t;;
 287--tag;;
 288        Create a tag by using the tags_subdir instead of the branches_subdir
 289        specified during git svn init.
 290
 291-d<path>;;
 292--destination=<path>;;
 293
 294        If more than one --branches (or --tags) option was given to the 'init'
 295        or 'clone' command, you must provide the location of the branch (or
 296        tag) you wish to create in the SVN repository.  <path> specifies which
 297        path to use to create the branch or tag and should match the pattern
 298        on the left-hand side of one of the configured branches or tags
 299        refspecs.  You can see these refspecs with the commands
 300+
 301        git config --get-all svn-remote.<name>.branches
 302        git config --get-all svn-remote.<name>.tags
 303+
 304where <name> is the name of the SVN repository as specified by the -R option to
 305'init' (or "svn" by default).
 306
 307--username;;
 308        Specify the SVN username to perform the commit as.  This option overrides
 309        the 'username' configuration property.
 310
 311--commit-url;;
 312        Use the specified URL to connect to the destination Subversion
 313        repository.  This is useful in cases where the source SVN
 314        repository is read-only.  This option overrides configuration
 315        property 'commiturl'.
 316+
 317        git config --get-all svn-remote.<name>.commiturl
 318+
 319
 320--parents;;
 321        Create parent folders. This parameter is equivalent to the parameter
 322        --parents on svn cp commands and is useful for non-standard repository
 323        layouts.
 324
 325'tag'::
 326        Create a tag in the SVN repository. This is a shorthand for
 327        'branch -t'.
 328
 329'log'::
 330        This should make it easy to look up svn log messages when svn
 331        users refer to -r/--revision numbers.
 332+
 333The following features from `svn log' are supported:
 334+
 335--
 336-r <n>[:<n>];;
 337--revision=<n>[:<n>];;
 338        is supported, non-numeric args are not:
 339        HEAD, NEXT, BASE, PREV, etc ...
 340-v;;
 341--verbose;;
 342        it's not completely compatible with the --verbose
 343        output in svn log, but reasonably close.
 344--limit=<n>;;
 345        is NOT the same as --max-count, doesn't count
 346        merged/excluded commits
 347--incremental;;
 348        supported
 349--
 350+
 351New features:
 352+
 353--
 354--show-commit;;
 355        shows the Git commit sha1, as well
 356--oneline;;
 357        our version of --pretty=oneline
 358--
 359+
 360NOTE: SVN itself only stores times in UTC and nothing else. The regular svn
 361client converts the UTC time to the local time (or based on the TZ=
 362environment). This command has the same behaviour.
 363+
 364Any other arguments are passed directly to 'git log'
 365
 366'blame'::
 367        Show what revision and author last modified each line of a file. The
 368        output of this mode is format-compatible with the output of
 369        `svn blame' by default. Like the SVN blame command,
 370        local uncommitted changes in the working tree are ignored;
 371        the version of the file in the HEAD revision is annotated. Unknown
 372        arguments are passed directly to 'git blame'.
 373+
 374--git-format;;
 375        Produce output in the same format as 'git blame', but with
 376        SVN revision numbers instead of Git commit hashes. In this mode,
 377        changes that haven't been committed to SVN (including local
 378        working-copy edits) are shown as revision 0.
 379
 380'find-rev'::
 381        When given an SVN revision number of the form 'rN', returns the
 382        corresponding Git commit hash (this can optionally be followed by a
 383        tree-ish to specify which branch should be searched).  When given a
 384        tree-ish, returns the corresponding SVN revision number.
 385+
 386--before;;
 387        Don't require an exact match if given an SVN revision, instead find
 388        the commit corresponding to the state of the SVN repository (on the
 389        current branch) at the specified revision.
 390+
 391--after;;
 392        Don't require an exact match if given an SVN revision; if there is
 393        not an exact match return the closest match searching forward in the
 394        history.
 395
 396'set-tree'::
 397        You should consider using 'dcommit' instead of this command.
 398        Commit specified commit or tree objects to SVN.  This relies on
 399        your imported fetch data being up-to-date.  This makes
 400        absolutely no attempts to do patching when committing to SVN, it
 401        simply overwrites files with those specified in the tree or
 402        commit.  All merging is assumed to have taken place
 403        independently of 'git svn' functions.
 404
 405'create-ignore'::
 406        Recursively finds the svn:ignore property on directories and
 407        creates matching .gitignore files. The resulting files are staged to
 408        be committed, but are not committed. Use -r/--revision to refer to a
 409        specific revision.
 410
 411'show-ignore'::
 412        Recursively finds and lists the svn:ignore property on
 413        directories.  The output is suitable for appending to
 414        the $GIT_DIR/info/exclude file.
 415
 416'mkdirs'::
 417        Attempts to recreate empty directories that core Git cannot track
 418        based on information in $GIT_DIR/svn/<refname>/unhandled.log files.
 419        Empty directories are automatically recreated when using
 420        "git svn clone" and "git svn rebase", so "mkdirs" is intended
 421        for use after commands like "git checkout" or "git reset".
 422        (See the svn-remote.<name>.automkdirs config file option for
 423        more information.)
 424
 425'commit-diff'::
 426        Commits the diff of two tree-ish arguments from the
 427        command-line.  This command does not rely on being inside an `git svn
 428        init`-ed repository.  This command takes three arguments, (a) the
 429        original tree to diff against, (b) the new tree result, (c) the
 430        URL of the target Subversion repository.  The final argument
 431        (URL) may be omitted if you are working from a 'git svn'-aware
 432        repository (that has been `init`-ed with 'git svn').
 433        The -r<revision> option is required for this.
 434
 435'info'::
 436        Shows information about a file or directory similar to what
 437        `svn info' provides.  Does not currently support a -r/--revision
 438        argument.  Use the --url option to output only the value of the
 439        'URL:' field.
 440
 441'proplist'::
 442        Lists the properties stored in the Subversion repository about a
 443        given file or directory.  Use -r/--revision to refer to a specific
 444        Subversion revision.
 445
 446'propget'::
 447        Gets the Subversion property given as the first argument, for a
 448        file.  A specific revision can be specified with -r/--revision.
 449
 450'show-externals'::
 451        Shows the Subversion externals.  Use -r/--revision to specify a
 452        specific revision.
 453
 454'gc'::
 455        Compress $GIT_DIR/svn/<refname>/unhandled.log files and remove
 456        $GIT_DIR/svn/<refname>/index files.
 457
 458'reset'::
 459        Undoes the effects of 'fetch' back to the specified revision.
 460        This allows you to re-'fetch' an SVN revision.  Normally the
 461        contents of an SVN revision should never change and 'reset'
 462        should not be necessary.  However, if SVN permissions change,
 463        or if you alter your --ignore-paths option, a 'fetch' may fail
 464        with "not found in commit" (file not previously visible) or
 465        "checksum mismatch" (missed a modification).  If the problem
 466        file cannot be ignored forever (with --ignore-paths) the only
 467        way to repair the repo is to use 'reset'.
 468+
 469Only the rev_map and refs/remotes/git-svn are changed (see
 470'$GIT_DIR/svn/\*\*/.rev_map.*' in the FILES section below for details).
 471Follow 'reset' with a 'fetch' and then 'git reset' or 'git rebase' to
 472move local branches onto the new tree.
 473
 474-r <n>;;
 475--revision=<n>;;
 476        Specify the most recent revision to keep.  All later revisions
 477        are discarded.
 478-p;;
 479--parent;;
 480        Discard the specified revision as well, keeping the nearest
 481        parent instead.
 482Example:;;
 483Assume you have local changes in "master", but you need to refetch "r2".
 484+
 485------------
 486    r1---r2---r3 remotes/git-svn
 487                \
 488                 A---B master
 489------------
 490+
 491Fix the ignore-paths or SVN permissions problem that caused "r2" to
 492be incomplete in the first place.  Then:
 493+
 494[verse]
 495git svn reset -r2 -p
 496git svn fetch
 497+
 498------------
 499    r1---r2'--r3' remotes/git-svn
 500      \
 501       r2---r3---A---B master
 502------------
 503+
 504Then fixup "master" with 'git rebase'.
 505Do NOT use 'git merge' or your history will not be compatible with a
 506future 'dcommit'!
 507+
 508[verse]
 509git rebase --onto remotes/git-svn A^ master
 510+
 511------------
 512    r1---r2'--r3' remotes/git-svn
 513                \
 514                 A'--B' master
 515------------
 516
 517OPTIONS
 518-------
 519
 520--shared[=(false|true|umask|group|all|world|everybody)]::
 521--template=<template_directory>::
 522        Only used with the 'init' command.
 523        These are passed directly to 'git init'.
 524
 525-r <arg>::
 526--revision <arg>::
 527           Used with the 'fetch' command.
 528+
 529This allows revision ranges for partial/cauterized history
 530to be supported.  $NUMBER, $NUMBER1:$NUMBER2 (numeric ranges),
 531$NUMBER:HEAD, and BASE:$NUMBER are all supported.
 532+
 533This can allow you to make partial mirrors when running fetch;
 534but is generally not recommended because history will be skipped
 535and lost.
 536
 537-::
 538--stdin::
 539        Only used with the 'set-tree' command.
 540+
 541Read a list of commits from stdin and commit them in reverse
 542order.  Only the leading sha1 is read from each line, so
 543'git rev-list --pretty=oneline' output can be used.
 544
 545--rmdir::
 546        Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
 547+
 548Remove directories from the SVN tree if there are no files left
 549behind.  SVN can version empty directories, and they are not
 550removed by default if there are no files left in them.  Git
 551cannot version empty directories.  Enabling this flag will make
 552the commit to SVN act like Git.
 553+
 554[verse]
 555config key: svn.rmdir
 556
 557-e::
 558--edit::
 559        Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
 560+
 561Edit the commit message before committing to SVN.  This is off by
 562default for objects that are commits, and forced on when committing
 563tree objects.
 564+
 565[verse]
 566config key: svn.edit
 567
 568-l<num>::
 569--find-copies-harder::
 570        Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
 571+
 572They are both passed directly to 'git diff-tree'; see
 573linkgit:git-diff-tree[1] for more information.
 574+
 575[verse]
 576config key: svn.l
 577config key: svn.findcopiesharder
 578
 579-A<filename>::
 580--authors-file=<filename>::
 581        Syntax is compatible with the file used by 'git cvsimport':
 582+
 583------------------------------------------------------------------------
 584        loginname = Joe User <user@example.com>
 585------------------------------------------------------------------------
 586+
 587If this option is specified and 'git svn' encounters an SVN
 588committer name that does not exist in the authors-file, 'git svn'
 589will abort operation. The user will then have to add the
 590appropriate entry.  Re-running the previous 'git svn' command
 591after the authors-file is modified should continue operation.
 592+
 593[verse]
 594config key: svn.authorsfile
 595
 596--authors-prog=<filename>::
 597        If this option is specified, for each SVN committer name that
 598        does not exist in the authors file, the given file is executed
 599        with the committer name as the first argument.  The program is
 600        expected to return a single line of the form "Name <email>",
 601        which will be treated as if included in the authors file.
 602
 603-q::
 604--quiet::
 605        Make 'git svn' less verbose. Specify a second time to make it
 606        even less verbose.
 607
 608--repack[=<n>]::
 609--repack-flags=<flags>::
 610        These should help keep disk usage sane for large fetches with
 611        many revisions.
 612+
 613--repack takes an optional argument for the number of revisions
 614to fetch before repacking.  This defaults to repacking every
 6151000 commits fetched if no argument is specified.
 616+
 617--repack-flags are passed directly to 'git repack'.
 618+
 619[verse]
 620config key: svn.repack
 621config key: svn.repackflags
 622
 623-m::
 624--merge::
 625-s<strategy>::
 626--strategy=<strategy>::
 627-p::
 628--preserve-merges::
 629        These are only used with the 'dcommit' and 'rebase' commands.
 630+
 631Passed directly to 'git rebase' when using 'dcommit' if a
 632'git reset' cannot be used (see 'dcommit').
 633
 634-n::
 635--dry-run::
 636        This can be used with the 'dcommit', 'rebase', 'branch' and
 637        'tag' commands.
 638+
 639For 'dcommit', print out the series of Git arguments that would show
 640which diffs would be committed to SVN.
 641+
 642For 'rebase', display the local branch associated with the upstream svn
 643repository associated with the current branch and the URL of svn
 644repository that will be fetched from.
 645+
 646For 'branch' and 'tag', display the urls that will be used for copying when
 647creating the branch or tag.
 648
 649--use-log-author::
 650        When retrieving svn commits into Git (as part of 'fetch', 'rebase', or
 651        'dcommit' operations), look for the first `From:` or `Signed-off-by:` line
 652        in the log message and use that as the author string.
 653--add-author-from::
 654        When committing to svn from Git (as part of 'commit-diff', 'set-tree' or 'dcommit'
 655        operations), if the existing log message doesn't already have a
 656        `From:` or `Signed-off-by:` line, append a `From:` line based on the
 657        Git commit's author string.  If you use this, then `--use-log-author`
 658        will retrieve a valid author string for all commits.
 659
 660
 661ADVANCED OPTIONS
 662----------------
 663
 664-i<GIT_SVN_ID>::
 665--id <GIT_SVN_ID>::
 666        This sets GIT_SVN_ID (instead of using the environment).  This
 667        allows the user to override the default refname to fetch from
 668        when tracking a single URL.  The 'log' and 'dcommit' commands
 669        no longer require this switch as an argument.
 670
 671-R<remote name>::
 672--svn-remote <remote name>::
 673        Specify the [svn-remote "<remote name>"] section to use,
 674        this allows SVN multiple repositories to be tracked.
 675        Default: "svn"
 676
 677--follow-parent::
 678        This option is only relevant if we are tracking branches (using
 679        one of the repository layout options --trunk, --tags,
 680        --branches, --stdlayout). For each tracked branch, try to find
 681        out where its revision was copied from, and set
 682        a suitable parent in the first Git commit for the branch.
 683        This is especially helpful when we're tracking a directory
 684        that has been moved around within the repository.  If this
 685        feature is disabled, the branches created by 'git svn' will all
 686        be linear and not share any history, meaning that there will be
 687        no information on where branches were branched off or merged.
 688        However, following long/convoluted histories can take a long
 689        time, so disabling this feature may speed up the cloning
 690        process. This feature is enabled by default, use
 691        --no-follow-parent to disable it.
 692+
 693[verse]
 694config key: svn.followparent
 695
 696CONFIG FILE-ONLY OPTIONS
 697------------------------
 698
 699svn.noMetadata::
 700svn-remote.<name>.noMetadata::
 701        This gets rid of the 'git-svn-id:' lines at the end of every commit.
 702+
 703This option can only be used for one-shot imports as 'git svn'
 704will not be able to fetch again without metadata. Additionally,
 705if you lose your '$GIT_DIR/svn/\*\*/.rev_map.*' files, 'git svn' will not
 706be able to rebuild them.
 707+
 708The 'git svn log' command will not work on repositories using
 709this, either.  Using this conflicts with the 'useSvmProps'
 710option for (hopefully) obvious reasons.
 711+
 712This option is NOT recommended as it makes it difficult to track down
 713old references to SVN revision numbers in existing documentation, bug
 714reports and archives.  If you plan to eventually migrate from SVN to Git
 715and are certain about dropping SVN history, consider
 716linkgit:git-filter-branch[1] instead.  filter-branch also allows
 717reformatting of metadata for ease-of-reading and rewriting authorship
 718info for non-"svn.authorsFile" users.
 719
 720svn.useSvmProps::
 721svn-remote.<name>.useSvmProps::
 722        This allows 'git svn' to re-map repository URLs and UUIDs from
 723        mirrors created using SVN::Mirror (or svk) for metadata.
 724+
 725If an SVN revision has a property, "svm:headrev", it is likely
 726that the revision was created by SVN::Mirror (also used by SVK).
 727The property contains a repository UUID and a revision.  We want
 728to make it look like we are mirroring the original URL, so
 729introduce a helper function that returns the original identity
 730URL and UUID, and use it when generating metadata in commit
 731messages.
 732
 733svn.useSvnsyncProps::
 734svn-remote.<name>.useSvnsyncprops::
 735        Similar to the useSvmProps option; this is for users
 736        of the svnsync(1) command distributed with SVN 1.4.x and
 737        later.
 738
 739svn-remote.<name>.rewriteRoot::
 740        This allows users to create repositories from alternate
 741        URLs.  For example, an administrator could run 'git svn' on the
 742        server locally (accessing via file://) but wish to distribute
 743        the repository with a public http:// or svn:// URL in the
 744        metadata so users of it will see the public URL.
 745
 746svn-remote.<name>.rewriteUUID::
 747        Similar to the useSvmProps option; this is for users who need
 748        to remap the UUID manually. This may be useful in situations
 749        where the original UUID is not available via either useSvmProps
 750        or useSvnsyncProps.
 751
 752svn-remote.<name>.pushurl::
 753
 754        Similar to Git's 'remote.<name>.pushurl', this key is designed
 755        to be used in cases where 'url' points to an SVN repository
 756        via a read-only transport, to provide an alternate read/write
 757        transport. It is assumed that both keys point to the same
 758        repository. Unlike 'commiturl', 'pushurl' is a base path. If
 759        either 'commiturl' or 'pushurl' could be used, 'commiturl'
 760        takes precedence.
 761
 762svn.brokenSymlinkWorkaround::
 763        This disables potentially expensive checks to workaround
 764        broken symlinks checked into SVN by broken clients.  Set this
 765        option to "false" if you track a SVN repository with many
 766        empty blobs that are not symlinks.  This option may be changed
 767        while 'git svn' is running and take effect on the next
 768        revision fetched.  If unset, 'git svn' assumes this option to
 769        be "true".
 770
 771svn.pathnameencoding::
 772        This instructs git svn to recode pathnames to a given encoding.
 773        It can be used by windows users and by those who work in non-utf8
 774        locales to avoid corrupted file names with non-ASCII characters.
 775        Valid encodings are the ones supported by Perl's Encode module.
 776
 777svn-remote.<name>.automkdirs::
 778        Normally, the "git svn clone" and "git svn rebase" commands
 779        attempt to recreate empty directories that are in the
 780        Subversion repository.  If this option is set to "false", then
 781        empty directories will only be created if the "git svn mkdirs"
 782        command is run explicitly.  If unset, 'git svn' assumes this
 783        option to be "true".
 784
 785Since the noMetadata, rewriteRoot, rewriteUUID, useSvnsyncProps and useSvmProps
 786options all affect the metadata generated and used by 'git svn'; they
 787*must* be set in the configuration file before any history is imported
 788and these settings should never be changed once they are set.
 789
 790Additionally, only one of these options can be used per svn-remote
 791section because they affect the 'git-svn-id:' metadata line, except
 792for rewriteRoot and rewriteUUID which can be used together.
 793
 794
 795BASIC EXAMPLES
 796--------------
 797
 798Tracking and contributing to the trunk of a Subversion-managed project
 799(ignoring tags and branches):
 800
 801------------------------------------------------------------------------
 802# Clone a repo (like git clone):
 803        git svn clone http://svn.example.com/project/trunk
 804# Enter the newly cloned directory:
 805        cd trunk
 806# You should be on master branch, double-check with 'git branch'
 807        git branch
 808# Do some work and commit locally to Git:
 809        git commit ...
 810# Something is committed to SVN, rebase your local changes against the
 811# latest changes in SVN:
 812        git svn rebase
 813# Now commit your changes (that were committed previously using Git) to SVN,
 814# as well as automatically updating your working HEAD:
 815        git svn dcommit
 816# Append svn:ignore settings to the default Git exclude file:
 817        git svn show-ignore >> .git/info/exclude
 818------------------------------------------------------------------------
 819
 820Tracking and contributing to an entire Subversion-managed project
 821(complete with a trunk, tags and branches):
 822
 823------------------------------------------------------------------------
 824# Clone a repo with standard SVN directory layout (like git clone):
 825        git svn clone http://svn.example.com/project --stdlayout --prefix svn/
 826# Or, if the repo uses a non-standard directory layout:
 827        git svn clone http://svn.example.com/project -T tr -b branch -t tag --prefix svn/
 828# View all branches and tags you have cloned:
 829        git branch -r
 830# Create a new branch in SVN
 831        git svn branch waldo
 832# Reset your master to trunk (or any other branch, replacing 'trunk'
 833# with the appropriate name):
 834        git reset --hard svn/trunk
 835# You may only dcommit to one branch/tag/trunk at a time.  The usage
 836# of dcommit/rebase/show-ignore should be the same as above.
 837------------------------------------------------------------------------
 838
 839The initial 'git svn clone' can be quite time-consuming
 840(especially for large Subversion repositories). If multiple
 841people (or one person with multiple machines) want to use
 842'git svn' to interact with the same Subversion repository, you can
 843do the initial 'git svn clone' to a repository on a server and
 844have each person clone that repository with 'git clone':
 845
 846------------------------------------------------------------------------
 847# Do the initial import on a server
 848        ssh server "cd /pub && git svn clone http://svn.example.com/project [options...]"
 849# Clone locally - make sure the refs/remotes/ space matches the server
 850        mkdir project
 851        cd project
 852        git init
 853        git remote add origin server:/pub/project
 854        git config --replace-all remote.origin.fetch '+refs/remotes/*:refs/remotes/*'
 855        git fetch
 856# Prevent fetch/pull from remote Git server in the future,
 857# we only want to use git svn for future updates
 858        git config --remove-section remote.origin
 859# Create a local branch from one of the branches just fetched
 860        git checkout -b master FETCH_HEAD
 861# Initialize 'git svn' locally (be sure to use the same URL and
 862# --stdlayout/-T/-b/-t/--prefix options as were used on server)
 863        git svn init http://svn.example.com/project [options...]
 864# Pull the latest changes from Subversion
 865        git svn rebase
 866------------------------------------------------------------------------
 867
 868REBASE VS. PULL/MERGE
 869---------------------
 870Prefer to use 'git svn rebase' or 'git rebase', rather than
 871'git pull' or 'git merge' to synchronize unintegrated commits with a 'git svn'
 872branch. Doing so will keep the history of unintegrated commits linear with
 873respect to the upstream SVN repository and allow the use of the preferred
 874'git svn dcommit' subcommand to push unintegrated commits back into SVN.
 875
 876Originally, 'git svn' recommended that developers pulled or merged from
 877the 'git svn' branch.  This was because the author favored
 878`git svn set-tree B` to commit a single head rather than the
 879`git svn set-tree A..B` notation to commit multiple commits. Use of
 880'git pull' or 'git merge' with `git svn set-tree A..B` will cause non-linear
 881history to be flattened when committing into SVN and this can lead to merge
 882commits unexpectedly reversing previous commits in SVN.
 883
 884MERGE TRACKING
 885--------------
 886While 'git svn' can track
 887copy history (including branches and tags) for repositories adopting a
 888standard layout, it cannot yet represent merge history that happened
 889inside git back upstream to SVN users.  Therefore it is advised that
 890users keep history as linear as possible inside Git to ease
 891compatibility with SVN (see the CAVEATS section below).
 892
 893HANDLING OF SVN BRANCHES
 894------------------------
 895If 'git svn' is configured to fetch branches (and --follow-branches
 896is in effect), it sometimes creates multiple Git branches for one
 897SVN branch, where the additional branches have names of the form
 898'branchname@nnn' (with nnn an SVN revision number).  These additional
 899branches are created if 'git svn' cannot find a parent commit for the
 900first commit in an SVN branch, to connect the branch to the history of
 901the other branches.
 902
 903Normally, the first commit in an SVN branch consists
 904of a copy operation. 'git svn' will read this commit to get the SVN
 905revision the branch was created from. It will then try to find the
 906Git commit that corresponds to this SVN revision, and use that as the
 907parent of the branch. However, it is possible that there is no suitable
 908Git commit to serve as parent.  This will happen, among other reasons,
 909if the SVN branch is a copy of a revision that was not fetched by 'git
 910svn' (e.g. because it is an old revision that was skipped with
 911'--revision'), or if in SVN a directory was copied that is not tracked
 912by 'git svn' (such as a branch that is not tracked at all, or a
 913subdirectory of a tracked branch). In these cases, 'git svn' will still
 914create a Git branch, but instead of using an existing Git commit as the
 915parent of the branch, it will read the SVN history of the directory the
 916branch was copied from and create appropriate Git commits.  This is
 917indicated by the message "Initializing parent: <branchname>".
 918
 919Additionally, it will create a special branch named
 920'<branchname>@<SVN-Revision>', where <SVN-Revision> is the SVN revision
 921number the branch was copied from.  This branch will point to the newly
 922created parent commit of the branch.  If in SVN the branch was deleted
 923and later recreated from a different version, there will be multiple
 924such branches with an '@'.
 925
 926Note that this may mean that multiple Git commits are created for a
 927single SVN revision.
 928
 929An example: in an SVN repository with a standard
 930trunk/tags/branches layout, a directory trunk/sub is created in r.100.
 931In r.200, trunk/sub is branched by copying it to branches/. 'git svn
 932clone -s' will then create a branch 'sub'. It will also create new Git
 933commits for r.100 through r.199 and use these as the history of branch
 934'sub'. Thus there will be two Git commits for each revision from r.100
 935to r.199 (one containing trunk/, one containing trunk/sub/). Finally,
 936it will create a branch 'sub@200' pointing to the new parent commit of
 937branch 'sub' (i.e. the commit for r.200 and trunk/sub/).
 938
 939CAVEATS
 940-------
 941
 942For the sake of simplicity and interoperating with Subversion,
 943it is recommended that all 'git svn' users clone, fetch and dcommit
 944directly from the SVN server, and avoid all 'git clone'/'pull'/'merge'/'push'
 945operations between Git repositories and branches.  The recommended
 946method of exchanging code between Git branches and users is
 947'git format-patch' and 'git am', or just 'dcommit'ing to the SVN repository.
 948
 949Running 'git merge' or 'git pull' is NOT recommended on a branch you
 950plan to 'dcommit' from because Subversion users cannot see any
 951merges you've made.  Furthermore, if you merge or pull from a Git branch
 952that is a mirror of an SVN branch, 'dcommit' may commit to the wrong
 953branch.
 954
 955If you do merge, note the following rule: 'git svn dcommit' will
 956attempt to commit on top of the SVN commit named in
 957------------------------------------------------------------------------
 958git log --grep=^git-svn-id: --first-parent -1
 959------------------------------------------------------------------------
 960You 'must' therefore ensure that the most recent commit of the branch
 961you want to dcommit to is the 'first' parent of the merge.  Chaos will
 962ensue otherwise, especially if the first parent is an older commit on
 963the same SVN branch.
 964
 965'git clone' does not clone branches under the refs/remotes/ hierarchy or
 966any 'git svn' metadata, or config.  So repositories created and managed with
 967using 'git svn' should use 'rsync' for cloning, if cloning is to be done
 968at all.
 969
 970Since 'dcommit' uses rebase internally, any Git branches you 'git push' to
 971before 'dcommit' on will require forcing an overwrite of the existing ref
 972on the remote repository.  This is generally considered bad practice,
 973see the linkgit:git-push[1] documentation for details.
 974
 975Do not use the --amend option of linkgit:git-commit[1] on a change you've
 976already dcommitted.  It is considered bad practice to --amend commits
 977you've already pushed to a remote repository for other users, and
 978dcommit with SVN is analogous to that.
 979
 980When cloning an SVN repository, if none of the options for describing
 981the repository layout is used (--trunk, --tags, --branches,
 982--stdlayout), 'git svn clone' will create a Git repository with
 983completely linear history, where branches and tags appear as separate
 984directories in the working copy.  While this is the easiest way to get a
 985copy of a complete repository, for projects with many branches it will
 986lead to a working copy many times larger than just the trunk. Thus for
 987projects using the standard directory structure (trunk/branches/tags),
 988it is recommended to clone with option '--stdlayout'. If the project
 989uses a non-standard structure, and/or if branches and tags are not
 990required, it is easiest to only clone one directory (typically trunk),
 991without giving any repository layout options.  If the full history with
 992branches and tags is required, the options '--trunk' / '--branches' /
 993'--tags' must be used.
 994
 995When using multiple --branches or --tags, 'git svn' does not automatically
 996handle name collisions (for example, if two branches from different paths have
 997the same name, or if a branch and a tag have the same name).  In these cases,
 998use 'init' to set up your Git repository then, before your first 'fetch', edit
 999the $GIT_DIR/config file so that the branches and tags are associated
1000with different name spaces.  For example:
1001
1002        branches = stable/*:refs/remotes/svn/stable/*
1003        branches = debug/*:refs/remotes/svn/debug/*
1004
1005BUGS
1006----
1007
1008We ignore all SVN properties except svn:executable.  Any unhandled
1009properties are logged to $GIT_DIR/svn/<refname>/unhandled.log
1010
1011Renamed and copied directories are not detected by Git and hence not
1012tracked when committing to SVN.  I do not plan on adding support for
1013this as it's quite difficult and time-consuming to get working for all
1014the possible corner cases (Git doesn't do it, either).  Committing
1015renamed and copied files is fully supported if they're similar enough
1016for Git to detect them.
1017
1018In SVN, it is possible (though discouraged) to commit changes to a tag
1019(because a tag is just a directory copy, thus technically the same as a
1020branch). When cloning an SVN repository, 'git svn' cannot know if such a
1021commit to a tag will happen in the future. Thus it acts conservatively
1022and imports all SVN tags as branches, prefixing the tag name with 'tags/'.
1023
1024CONFIGURATION
1025-------------
1026
1027'git svn' stores [svn-remote] configuration information in the
1028repository $GIT_DIR/config file.  It is similar the core Git
1029[remote] sections except 'fetch' keys do not accept glob
1030arguments; but they are instead handled by the 'branches'
1031and 'tags' keys.  Since some SVN repositories are oddly
1032configured with multiple projects glob expansions such those
1033listed below are allowed:
1034
1035------------------------------------------------------------------------
1036[svn-remote "project-a"]
1037        url = http://server.org/svn
1038        fetch = trunk/project-a:refs/remotes/project-a/trunk
1039        branches = branches/*/project-a:refs/remotes/project-a/branches/*
1040        tags = tags/*/project-a:refs/remotes/project-a/tags/*
1041------------------------------------------------------------------------
1042
1043Keep in mind that the '\*' (asterisk) wildcard of the local ref
1044(right of the ':') *must* be the farthest right path component;
1045however the remote wildcard may be anywhere as long as it's an
1046independent path component (surrounded by '/' or EOL).   This
1047type of configuration is not automatically created by 'init' and
1048should be manually entered with a text-editor or using 'git config'.
1049
1050It is also possible to fetch a subset of branches or tags by using a
1051comma-separated list of names within braces. For example:
1052
1053------------------------------------------------------------------------
1054[svn-remote "huge-project"]
1055        url = http://server.org/svn
1056        fetch = trunk/src:refs/remotes/trunk
1057        branches = branches/{red,green}/src:refs/remotes/project-a/branches/*
1058        tags = tags/{1.0,2.0}/src:refs/remotes/project-a/tags/*
1059------------------------------------------------------------------------
1060
1061Multiple fetch, branches, and tags keys are supported:
1062
1063------------------------------------------------------------------------
1064[svn-remote "messy-repo"]
1065        url = http://server.org/svn
1066        fetch = trunk/project-a:refs/remotes/project-a/trunk
1067        fetch = branches/demos/june-project-a-demo:refs/remotes/project-a/demos/june-demo
1068        branches = branches/server/*:refs/remotes/project-a/branches/*
1069        branches = branches/demos/2011/*:refs/remotes/project-a/2011-demos/*
1070        tags = tags/server/*:refs/remotes/project-a/tags/*
1071------------------------------------------------------------------------
1072
1073Creating a branch in such a configuration requires disambiguating which
1074location to use using the -d or --destination flag:
1075
1076------------------------------------------------------------------------
1077$ git svn branch -d branches/server release-2-3-0
1078------------------------------------------------------------------------
1079
1080Note that git-svn keeps track of the highest revision in which a branch
1081or tag has appeared. If the subset of branches or tags is changed after
1082fetching, then $GIT_DIR/svn/.metadata must be manually edited to remove
1083(or reset) branches-maxRev and/or tags-maxRev as appropriate.
1084
1085FILES
1086-----
1087$GIT_DIR/svn/\*\*/.rev_map.*::
1088        Mapping between Subversion revision numbers and Git commit
1089        names.  In a repository where the noMetadata option is not set,
1090        this can be rebuilt from the git-svn-id: lines that are at the
1091        end of every commit (see the 'svn.noMetadata' section above for
1092        details).
1093+
1094'git svn fetch' and 'git svn rebase' automatically update the rev_map
1095if it is missing or not up to date.  'git svn reset' automatically
1096rewinds it.
1097
1098SEE ALSO
1099--------
1100linkgit:git-rebase[1]
1101
1102GIT
1103---
1104Part of the linkgit:git[1] suite