Re: [PATCH] Add warning about known issues to documentation of cvsimport

[Heiko Voigt <hvoigt@hvoigt.net>]

On Tue, Mar 31, 2009 at 07:36:16AM +0200, Ferry Huberts (Pelagic) wrote:
> Heiko Voigt wrote:
> > On Mon, Mar 23, 2009 at 09:33:55PM +0100, Ferry Huberts (Pelagic) wrote:
> >> maybe you can also add remarks about autocrlf and safecrlf?
> >> both need to be off
> > 
> > From my experience thats not necessarily true. You can use
> > autocrlf=input to repair broken revisions were crlf's have been
> > mistakenly committed into the repository. And if I remember correctly
> > safecrlf helps if you want to make sure that no information gets lost.
> > 
> > So when importing from a nice correct cvs repository you would expect
> > safecrlf to not stop your import. And I suspect there are actually cvs
> > users that were very careful with their lineendings who would use it.
> > 
> > cheers Heiko
> If you look at this thread:
> http://thread.gmane.org/gmane.comp.version-control.git/110152/focus=110358
> you'll see why I said it. I did some testing to prove my statement.

Well, from that thread I see my statement supported. It is not true that
they *need* to be off. Maybe a statement that certain crlf settings are
exclusive would be good, but I agree that should go into the config
documentation.

The main point I see here is that the User may not be aware that such a
conversion is applied so something like this could help.

cheers Heiko

diff --git a/Documentation/git-cvsimport.txt b/Documentation/git-cvsimport.txt
index e1fd047..d4e7fd4 100644
--- a/Documentation/git-cvsimport.txt
+++ b/Documentation/git-cvsimport.txt
@@ -40,6 +40,11 @@ probably want to make a bare clone of the imported repository
 and use the clone as the shared repository.
 See linkgit:gitcvs-migration[7].
 
+Note: All revisions are imported using the index so settings of
+core.autocrlf and core.safecrlf are applied. This way you can change or
+safety check the import. If you do not want this make sure these options
+are both set to false.
+
 
 OPTIONS
 -------