Documentation/git-svn: discourage "noMetadata"
"noMetadata" is a sometimes harmful option, so better document its behavior and limitations. Suggested-by: Vadim Zeitlin Signed-off-by: Eric Wong <normalperson@yhbt.net>
Eric Wong committed
Aug 21, 2010 at 18:52 UTC
c9be27f39488b20946e3a7ba57d776e03708a1fa
1 file changed
+14
-3
Documentation/git-svn.txt
+14
-3
@@ -56,6 +56,8 @@ COMMANDS
56
as well, they take precedence.
57
--no-metadata;;
58
Set the 'noMetadata' option in the [svn-remote] config.
59
+ This option is not recommended, please read the 'svn.noMetadata'
60
+ section of this manpage before using this option.
61
--use-svm-props;;
62
Set the 'useSvmProps' option in the [svn-remote] config.
63
--use-svnsync-props;;
@@ -597,13 +599,22 @@ svn.noMetadata::
599
svn-remote.<name>.noMetadata::
600
This gets rid of the 'git-svn-id:' lines at the end of every commit.
601
+
600
-If you lose your .git/svn/git-svn/.rev_db file, 'git svn' will not
601
-be able to rebuild it and you won't be able to fetch again,
602
-either. This is fine for one-shot imports.
602
+This option can only be used for one-shot imports as 'git svn'
603
+will not be able to fetch again without metadata. Additionally,
604
+if you lose your .git/svn/**/.rev_map.* files, 'git svn' will not
605
+be able to rebuild them.
606
+
607
The 'git svn log' command will not work on repositories using
608
this, either. Using this conflicts with the 'useSvmProps'
609
option for (hopefully) obvious reasons.
610
++
611
+This option is NOT recommended as it makes it difficult to track down
612
+old references to SVN revision numbers in existing documentation, bug
613
+reports and archives. If you plan to eventually migrate from SVN to git
614
+and are certain about dropping SVN history, consider
615
+linkgit:git-filter-branch[1] instead. filter-branch also allows
616
+reformating of metadata for ease-of-reading and rewriting authorship
617
+info for non-"svn.authorsFile" users.
618
619
svn.useSvmProps::
620
svn-remote.<name>.useSvmProps::