Documentation / git-svnimport.txton commit Merge branch 'jc/ident' (6ead397)
   1git-svnimport(1)
   2================
   3v0.1, July 2005
   4
   5NAME
   6----
   7git-svnimport - Import a SVN repository into git
   8
   9
  10SYNOPSIS
  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
  19DESCRIPTION
  20-----------
  21Imports a SVN repository into git. It will either create a new
  22repository, or incrementally import into an existing one.
  23
  24SVN access is done by the SVN::Perl module.
  25
  26git-svnimport assumes that SVN repositories are organized into one
  27"trunk" directory where the main development happens, "branch/FOO"
  28directories for branches, and "/tags/FOO" directories for tags.
  29Other subdirectories are ignored.
  30
  31git-svnimport creates a file ".git/svn2git", which is required for
  32incremental SVN imports.
  33
  34OPTIONS
  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+
  43When 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-m::
  69        Attempt to detect merges based on the commit message. This option
  70        will enable default regexes that try to capture the name source
  71        branch name from the commit message.
  72
  73-M <regex>::
  74        Attempt to detect merges based on the commit message with a custom
  75        regex. It can be used with -m to also see the default regexes.
  76        You must escape forward slashes.
  77
  78-l <max_rev>::
  79        Specify a maximum revision number to pull.
  80
  81        Formerly, this option controlled how many revisions to pull,
  82        due to SVN memory leaks. (These have been worked around.)
  83
  84-v::
  85        Verbosity: let 'svnimport' report what it is doing.
  86
  87-d::
  88        Use direct HTTP requests if possible. The "<path>" argument is used
  89        only for retrieving the SVN logs; the path to the contents is
  90        included in the SVN log.
  91
  92-D::
  93        Use direct HTTP requests if possible. The "<path>" argument is used
  94        for retrieving the logs, as well as for the contents.
  95+
  96There's no safe way to automatically find out which of these options to
  97use, so you need to try both. Usually, the one that's wrong will die
  98with a 40x error pretty quickly.
  99
 100<SVN_repository_URL>::
 101        The URL of the SVN module you want to import. For local
 102        repositories, use "file:///absolute/path".
 103+
 104If you're using the "-d" or "-D" option, this is the URL of the SVN
 105repository itself; it usually ends in "/svn".
 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
 113OUTPUT
 114------
 115If '-v' is specified, the script reports what it is doing.
 116
 117Otherwise, success is indicated the Unix way, i.e. by simply exiting with
 118a zero exit status.
 119
 120Author
 121------
 122Written by Matthias Urlichs <smurf@smurf.noris.de>, with help from
 123various participants of the git-list <git@vger.kernel.org>.
 124
 125Based on a cvs2git script by the same author.
 126
 127Documentation
 128--------------
 129Documentation by Matthias Urlichs <smurf@smurf.noris.de>.
 130
 131GIT
 132---
 133Part of the gitlink:git[7] suite
 134