Documentation/git-svnimport.txt

   1 git-svnimport(1)
   2 ================
   3 v0.1, July 2005
   4
   5 NAME
   6 ----
   7 git-svnimport - Import a SVN repository into git
   8
   9
  10 SYNOPSIS
  11 --------
  12 'git-svnimport' [ -o <branch-for-HEAD> ] [ -h ] [ -v ] [ -d | -D ]
  13                         [ -C <GIT_repository> ] [ -i ] [ -u ] [-l limit_rev]
  14                         [ -b branch_subdir ] [ -T trunk_subdir ] [ -t tag_subdir ]
  15                         [ -s start_chg ] [ -m ] [ -M regex ]
  16                         <SVN_repository_URL> [ <path> ]
  17
  18
  19 DESCRIPTION
  20 -----------
  21 Imports a SVN repository into git. It will either create a new
  22 repository, or incrementally import into an existing one.
  23
  24 SVN access is done by the SVN:: Perl module.
  25
  26 git-svnimport assumes that SVN repositories are organized into one
  27 "trunk" directory where the main development happens, "branch/FOO"
  28 directories for branches, and "/tags/FOO" directories for tags.
  29 Other subdirectories are ignored.
  30
  31 git-svnimport creates a file ".git/svn2git", which is required for
  32 incremental SVN imports.
  33
  34 OPTIONS
  35 -------
  36 -C <target-dir>::
  37         The GIT repository to import to.  If the directory doesn't
  38         exist, it will be created.  Default is the current directory.
  39
  40 -s <start_rev>::
  41         Start importing at this SVN change number. The  default is 1.
  42 +
  43 When importing incrementally, you might need to edit the .git/svn2git file.
  44
  45 -i::
  46         Import-only: don't perform a checkout after importing.  This option
  47         ensures the working directory and index remain untouched and will
  48         not create them if they do not exist.
  49
  50 -T <trunk_subdir>::
  51         Name the SVN trunk. Default "trunk".
  52
  53 -t <tag_subdir>::
  54         Name the SVN subdirectory for tags. Default "tags".
  55
  56 -b <branch_subdir>::
  57         Name the SVN subdirectory for branches. Default "branches".
  58
  59 -o <branch-for-HEAD>::
  60         The 'trunk' branch from SVN is imported to the 'origin' branch within
  61         the git repository. Use this option if you want to import into a
  62         different branch.
  63
  64 -m::
  65         Attempt to detect merges based on the commit message. This option
  66         will enable default regexes that try to capture the name source
  67         branch name from the commit message.
  68
  69 -M <regex>::
  70         Attempt to detect merges based on the commit message with a custom
  71         regex. It can be used with -m to also see the default regexes.
  72         You must escape forward slashes.
  73
  74 -l <max_rev>::
  75         Specify a maximum revision number to pull.
  76
  77         Formerly, this option controlled how many revisions to pull, due to
  78         SVN memory leaks. (These have been worked around.)
  79
  80 -v::
  81         Verbosity: let 'svnimport' report what it is doing.
  82
  83 -d::
  84         Use direct HTTP requests if possible. The "<path>" argument is used
  85         only for retrieving the SVN logs; the path to the contents is
  86         included in the SVN log.
  87
  88 -D::
  89         Use direct HTTP requests if possible. The "<path>" argument is used
  90         for retrieving the logs, as well as for the contents.
  91 +
  92 There's no safe way to automatically find out which of these options to
  93 use, so you need to try both. Usually, the one that's wrong will die
  94 with a 40x error pretty quickly.
  95
  96 <SVN_repository_URL>::
  97         The URL of the SVN module you want to import. For local
  98         repositories, use "file:///absolute/path".
  99 +
 100 If you're using the "-d" or "-D" option, this is the URL of the SVN
 101 repository itself; it usually ends in "/svn".
 102
 103 <SVN_repository_URL>::
 104         The URL of the SVN module you want to import. For local
 105         repositories, use "file:///absolute/path".
 106
 107 <path>
 108         The path to the module you want to check out.
 109
 110 -h::
 111         Print a short usage message and exit.
 112
 113 OUTPUT
 114 ------
 115 If '-v' is specified, the script reports what it is doing.
 116
 117 Otherwise, success is indicated the Unix way, i.e. by simply exiting with
 118 a zero exit status.
 119
 120 Author
 121 ------
 122 Written by Matthias Urlichs <smurf@smurf.noris.de>, with help from
 123 various participants of the git-list <git@vger.kernel.org>.
 124
 125 Based on a cvs2git script by the same author.
 126
 127 Documentation
 128 --------------
 129 Documentation by Matthias Urlichs <smurf@smurf.noris.de>.
 130
 131 GIT
 132 ---
 133 Part of the gitlink:git[7] suite
 134