svnimport: Read author names and emails from a file

[git.git] / Documentation / git-svnimport.txt

diff --git a/Documentation/git-svnimport.txt b/Documentation/git-svnimport.txt
index 88bdc08..e0e3a5d 100644 (file)
--- a/Documentation/git-svnimport.txt
+++ b/Documentation/git-svnimport.txt
@@ -10,10 +10,11 @@ git-svnimport - Import a SVN repository into git
 SYNOPSIS
 --------
 'git-svnimport' [ -o <branch-for-HEAD> ] [ -h ] [ -v ] [ -d | -D ]
-                       [ -C <GIT_repository> ] [ -i ] [ -u ] [-l limit_nr_changes]
-                       [ -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
@@ -21,7 +22,7 @@ DESCRIPTION
 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"
@@ -40,17 +41,17 @@ OPTIONS
 -s <start_rev>::
         Start importing at this SVN change number. The  default is 1.
 +
-When importing incementally, you might need to edit the .git/svn2git file.
+When importing incrementally, you might need to edit the .git/svn2git file.
 
 -i::
        Import-only: don't perform a checkout after importing.  This option
-       ensures the working directory and cache remain untouched and will
+       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".
 
--T <tag_subdir>::
+-t <tag_subdir>::
        Name the SVN subdirectory for tags. Default "tags".
 
 -b <branch_subdir>::
@@ -61,6 +62,26 @@ When importing incementally, you might need to edit the .git/svn2git file.
        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@addres.org>
+
+       and use "User's Full Name <email@addres.org>" 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.
+
 -m::
        Attempt to detect merges based on the commit message. This option
        will enable default regexes that try to capture the name source
@@ -71,14 +92,11 @@ When importing incementally, you might need to edit the .git/svn2git file.
        regex. It can be used with -m to also see the default regexes.
        You must escape forward slashes.
 
--l <max_num_changes>::
-       Limit the number of SVN changesets we pull before quitting.
-       This option is necessary because the SVN library has serious memory
-       leaks; the recommended value for nontrivial imports is 100.
+-l <max_rev>::
+       Specify a maximum revision number to pull.
 
-       git-svnimport will still exit with a zero exit code. You can check
-       the size of the file ".git/svn2git" to determine whether to call
-       the importer again.
+       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.
@@ -103,11 +121,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".
 
-<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::