make clean: remove dist-doc targets.
[git.git] / Documentation / git-svnimport.txt
index 6e342f5..b1b87c2 100644 (file)
@@ -9,11 +9,13 @@ git-svnimport - Import a SVN repository into git
 
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------
+[verse]
 'git-svnimport' [ -o <branch-for-HEAD> ] [ -h ] [ -v ] [ -d | -D ]
 'git-svnimport' [ -o <branch-for-HEAD> ] [ -h ] [ -v ] [ -d | -D ]
-                       [ -C <GIT_repository> ] [ -i ] [ -u ] [-l limit_rev]
-                       [ -b branch_subdir ] [ -t trunk_subdir ] [ -T tag_subdir ]
-                       [ -s start_chg ] [ -m ] [ -M regex ]
-                       <SVN_repository_URL> [ <path> ]
+               [ -C <GIT_repository> ] [ -i ] [ -u ] [-l limit_rev]
+               [ -b branch_subdir ] [ -T trunk_subdir ] [ -t tag_subdir ]
+               [ -s start_chg ] [ -m ] [ -r ] [ -M regex ]
+               [ -I <ignorefile_name> ] [ -A <author_file> ]
+               <SVN_repository_URL> [ <path> ]
 
 
 DESCRIPTION
 
 
 DESCRIPTION
@@ -21,7 +23,7 @@ DESCRIPTION
 Imports a SVN repository into git. It will either create a new
 repository, or incrementally import into an existing one.
 
 Imports a SVN repository into git. It will either create a new
 repository, or incrementally import into an existing one.
 
-SVN access is done by the SVN:: Perl module.
+SVN access is done by the SVN::Perl module.
 
 git-svnimport assumes that SVN repositories are organized into one
 "trunk" directory where the main development happens, "branch/FOO"
 
 git-svnimport assumes that SVN repositories are organized into one
 "trunk" directory where the main development happens, "branch/FOO"
@@ -47,10 +49,10 @@ When importing incrementally, you might need to edit the .git/svn2git file.
        ensures the working directory and index remain untouched and will
        not create them if they do not exist.
 
        ensures the working directory and index remain untouched and will
        not create them if they do not exist.
 
--t <trunk_subdir>::
+-T <trunk_subdir>::
        Name the SVN trunk. Default "trunk".
 
        Name the SVN trunk. Default "trunk".
 
--T <tag_subdir>::
+-t <tag_subdir>::
        Name the SVN subdirectory for tags. Default "tags".
 
 -b <branch_subdir>::
        Name the SVN subdirectory for tags. Default "tags".
 
 -b <branch_subdir>::
@@ -61,6 +63,34 @@ When importing incrementally, you might need to edit the .git/svn2git file.
        the git repository. Use this option if you want to import into a
        different branch.
 
        the git repository. Use this option if you want to import into a
        different branch.
 
+-r::
+       Prepend 'rX: ' to commit messages, where X is the imported
+       subversion revision.
+
+-I <ignorefile_name>::
+       Import the svn:ignore directory property to files with this
+       name in each directory. (The Subversion and GIT ignore
+       syntaxes are similar enough that using the Subversion patterns
+       directly with "-I .gitignore" will almost always just work.)
+
+-A <author_file>::
+       Read a file with lines on the form
++
+------
+       username = User's Full Name <email@addr.es>
+
+------
++
+and use "User's Full Name <email@addr.es>" as the GIT
+author and committer for Subversion commits made by
+"username". If encountering a commit made by a user not in the
+list, abort.
++
+For convenience, this data is saved to $GIT_DIR/svn-authors
+each time the -A option is provided, and read from that same
+file each time git-svnimport is run with an existing GIT
+repository without -A.
+
 -m::
        Attempt to detect merges based on the commit message. This option
        will enable default regexes that try to capture the name source
 -m::
        Attempt to detect merges based on the commit message. This option
        will enable default regexes that try to capture the name source
@@ -74,8 +104,8 @@ When importing incrementally, you might need to edit the .git/svn2git file.
 -l <max_rev>::
        Specify a maximum revision number to pull.
 
 -l <max_rev>::
        Specify a maximum revision number to pull.
 
-       Formerly, this option controlled how many revisions to pull, due to
-       SVN memory leaks. (These have been worked around.)
+       Formerly, this option controlled how many revisions to pull,
+       due to SVN memory leaks. (These have been worked around.)
 
 -v::
        Verbosity: let 'svnimport' report what it is doing.
 
 -v::
        Verbosity: let 'svnimport' report what it is doing.
@@ -100,11 +130,7 @@ with a 40x error pretty quickly.
 If you're using the "-d" or "-D" option, this is the URL of the SVN
 repository itself; it usually ends in "/svn".
 
 If you're using the "-d" or "-D" option, this is the URL of the SVN
 repository itself; it usually ends in "/svn".
 
-<SVN_repository_URL>::
-       The URL of the SVN module you want to import. For local
-       repositories, use "file:///absolute/path".
-
-<path>
+<path>::
        The path to the module you want to check out.
 
 -h::
        The path to the module you want to check out.
 
 -h::