Documentation / git-svnimport.txton commit Update packedGit config option documentation. (eb92242)
   1git-svnimport(1)
   2================
   3v0.1, July 2005
   4
   5NAME
   6----
   7git-svnimport - Import a SVN repository into git
   8
   9
  10SYNOPSIS
  11--------
  12[verse]
  13'git-svnimport' [ -o <branch-for-HEAD> ] [ -h ] [ -v ] [ -d | -D ]
  14                [ -C <GIT_repository> ] [ -i ] [ -u ] [-l limit_rev]
  15                [ -b branch_subdir ] [ -T trunk_subdir ] [ -t tag_subdir ]
  16                [ -s start_chg ] [ -m ] [ -r ] [ -M regex ]
  17                [ -I <ignorefile_name> ] [ -A <author_file> ]
  18                [ -P <path_from_trunk> ]
  19                <SVN_repository_URL> [ <path> ]
  20
  21
  22DESCRIPTION
  23-----------
  24Imports a SVN repository into git. It will either create a new
  25repository, or incrementally import into an existing one.
  26
  27SVN access is done by the SVN::Perl module.
  28
  29git-svnimport assumes that SVN repositories are organized into one
  30"trunk" directory where the main development happens, "branch/FOO"
  31directories for branches, and "/tags/FOO" directories for tags.
  32Other subdirectories are ignored.
  33
  34git-svnimport creates a file ".git/svn2git", which is required for
  35incremental SVN imports.
  36
  37OPTIONS
  38-------
  39-C <target-dir>::
  40        The GIT repository to import to.  If the directory doesn't
  41        exist, it will be created.  Default is the current directory.
  42
  43-s <start_rev>::
  44        Start importing at this SVN change number. The  default is 1.
  45+
  46When importing incrementally, you might need to edit the .git/svn2git file.
  47
  48-i::
  49        Import-only: don't perform a checkout after importing.  This option
  50        ensures the working directory and index remain untouched and will
  51        not create them if they do not exist.
  52
  53-T <trunk_subdir>::
  54        Name the SVN trunk. Default "trunk".
  55
  56-t <tag_subdir>::
  57        Name the SVN subdirectory for tags. Default "tags".
  58
  59-b <branch_subdir>::
  60        Name the SVN subdirectory for branches. Default "branches".
  61
  62-o <branch-for-HEAD>::
  63        The 'trunk' branch from SVN is imported to the 'origin' branch within
  64        the git repository. Use this option if you want to import into a
  65        different branch.
  66
  67-r::
  68        Prepend 'rX: ' to commit messages, where X is the imported
  69        subversion revision.
  70
  71-I <ignorefile_name>::
  72        Import the svn:ignore directory property to files with this
  73        name in each directory. (The Subversion and GIT ignore
  74        syntaxes are similar enough that using the Subversion patterns
  75        directly with "-I .gitignore" will almost always just work.)
  76
  77-A <author_file>::
  78        Read a file with lines on the form
  79+
  80------
  81        username = User's Full Name <email@addr.es>
  82
  83------
  84+
  85and use "User's Full Name <email@addr.es>" as the GIT
  86author and committer for Subversion commits made by
  87"username". If encountering a commit made by a user not in the
  88list, abort.
  89+
  90For convenience, this data is saved to $GIT_DIR/svn-authors
  91each time the -A option is provided, and read from that same
  92file each time git-svnimport is run with an existing GIT
  93repository without -A.
  94
  95-m::
  96        Attempt to detect merges based on the commit message. This option
  97        will enable default regexes that try to capture the name source
  98        branch name from the commit message.
  99
 100-M <regex>::
 101        Attempt to detect merges based on the commit message with a custom
 102        regex. It can be used with -m to also see the default regexes.
 103        You must escape forward slashes.
 104
 105-l <max_rev>::
 106        Specify a maximum revision number to pull.
 107+
 108Formerly, this option controlled how many revisions to pull,
 109due to SVN memory leaks. (These have been worked around.)
 110
 111-P <path_from_trunk>::
 112        Partial import of the SVN tree.
 113+
 114By default, the whole tree on the SVN trunk (/trunk) is imported.
 115'-P my/proj' will import starting only from '/trunk/my/proj'.
 116This option is useful when you want to import one project from a
 117svn repo which hosts multiple projects under the same trunk.
 118
 119-v::
 120        Verbosity: let 'svnimport' report what it is doing.
 121
 122-d::
 123        Use direct HTTP requests if possible. The "<path>" argument is used
 124        only for retrieving the SVN logs; the path to the contents is
 125        included in the SVN log.
 126
 127-D::
 128        Use direct HTTP requests if possible. The "<path>" argument is used
 129        for retrieving the logs, as well as for the contents.
 130+
 131There's no safe way to automatically find out which of these options to
 132use, so you need to try both. Usually, the one that's wrong will die
 133with a 40x error pretty quickly.
 134
 135<SVN_repository_URL>::
 136        The URL of the SVN module you want to import. For local
 137        repositories, use "file:///absolute/path".
 138+
 139If you're using the "-d" or "-D" option, this is the URL of the SVN
 140repository itself; it usually ends in "/svn".
 141
 142<path>::
 143        The path to the module you want to check out.
 144
 145-h::
 146        Print a short usage message and exit.
 147
 148OUTPUT
 149------
 150If '-v' is specified, the script reports what it is doing.
 151
 152Otherwise, success is indicated the Unix way, i.e. by simply exiting with
 153a zero exit status.
 154
 155Author
 156------
 157Written by Matthias Urlichs <smurf@smurf.noris.de>, with help from
 158various participants of the git-list <git@vger.kernel.org>.
 159
 160Based on a cvs2git script by the same author.
 161
 162Documentation
 163--------------
 164Documentation by Matthias Urlichs <smurf@smurf.noris.de>.
 165
 166GIT
 167---
 168Part of the gitlink:git[7] suite
 169