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 ] [ -r ] [ -M regex ]
  16                 [ -I <ignorefile_name> ] <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 -r::
  65         Prepend 'rX: ' to commit messages, where X is the imported
  66         subversion revision.
  67
  68 -I <ignorefile_name>::
  69         Import the svn:ignore directory property to files with this
  70         name in each directory. (The Subversion and GIT ignore
  71         syntaxes are similar enough that using the Subversion patterns
  72         directly with "-I .gitignore" will almost always just work.)
  73
  74 -m::
  75         Attempt to detect merges based on the commit message. This option
  76         will enable default regexes that try to capture the name source
  77         branch name from the commit message.
  78
  79 -M <regex>::
  80         Attempt to detect merges based on the commit message with a custom
  81         regex. It can be used with -m to also see the default regexes.
  82         You must escape forward slashes.
  83
  84 -l <max_rev>::
  85         Specify a maximum revision number to pull.
  86
  87         Formerly, this option controlled how many revisions to pull,
  88         due to SVN memory leaks. (These have been worked around.)
  89
  90 -v::
  91         Verbosity: let 'svnimport' report what it is doing.
  92
  93 -d::
  94         Use direct HTTP requests if possible. The "<path>" argument is used
  95         only for retrieving the SVN logs; the path to the contents is
  96         included in the SVN log.
  97
  98 -D::
  99         Use direct HTTP requests if possible. The "<path>" argument is used
 100         for retrieving the logs, as well as for the contents.
 101 +
 102 There's no safe way to automatically find out which of these options to
 103 use, so you need to try both. Usually, the one that's wrong will die
 104 with a 40x error pretty quickly.
 105
 106 <SVN_repository_URL>::
 107         The URL of the SVN module you want to import. For local
 108         repositories, use "file:///absolute/path".
 109 +
 110 If you're using the "-d" or "-D" option, this is the URL of the SVN
 111 repository itself; it usually ends in "/svn".
 112
 113 <path>::
 114         The path to the module you want to check out.
 115
 116 -h::
 117         Print a short usage message and exit.
 118
 119 OUTPUT
 120 ------
 121 If '-v' is specified, the script reports what it is doing.
 122
 123 Otherwise, success is indicated the Unix way, i.e. by simply exiting with
 124 a zero exit status.
 125
 126 Author
 127 ------
 128 Written by Matthias Urlichs <smurf@smurf.noris.de>, with help from
 129 various participants of the git-list <git@vger.kernel.org>.
 130
 131 Based on a cvs2git script by the same author.
 132
 133 Documentation
 134 --------------
 135 Documentation by Matthias Urlichs <smurf@smurf.noris.de>.
 136
 137 GIT
 138 ---
 139 Part of the gitlink:git[7] suite
 140