613327 - opening readme.txt in notepad on Windows displays the content all on one line

Status: RESOLVED FIXED

(Add-on SDK Graveyard :: General, defect)

Description

[Myk Melez [:myk] [@mykmelez]]

Opening readme.txt on notepad on Windows displays the content of the file all on one line, making it very difficult to read.  It should be properly wrapped on Windows, as it is on Mac and Linux.

Comment 1

[Will Bamberg [:wbamberg]]

Attachment: Fix for bugs 613327, 613328, 613330, 613335

Also here: https://github.com/wbamberg/jetpack-sdk/tree/bug613327

Git complains about trailing whitespace when I apply the patch, maybe this is because of the CRLF line endings? 

In general there are some subtleties with Git and Windows line endings, see: http://help.github.com/dealing-with-lineendings/ 

If I understand this, we should not use autocrlf=input or autocrlf=true, or files which we intend to have CRLF line ending will not have them. Does that seem right?

Comment 2

[Erik Vold]

(In reply to comment #1)
> If I understand this, we should not use autocrlf=input or autocrlf=true, or
> files which we intend to have CRLF line ending will not have them. Does that
> seem right?

use: git config --global core.autocrlf false

That way you'll checkout files as they are in the repo, and you'll commit them as they are on your HD.

The advice given everywhere I look on this seems to be geared towards forcing everyone to commit everything with LF line endings, then have git checkout the repo with the line endings that are appropriate for the OS being used. I don't think that's a great idea though..

Comment 3

[Myk Melez [:myk] [@mykmelez]]

Comment on attachment 493086 [details] [diff] [review]
Fix for bugs 613327, 613328, 613330, 613335

Looks good generally, except that the following three lines still use bare LF line endings:

    http://python.org/download/
  
  Note that Python 3.0 and 3.1 are not supported in this release.

r=myk with those line endings fixed!


(In reply to comment #2)
> use: git config --global core.autocrlf false

I set this, but I still got a bunch of complaints about trailing whitespace when I applied the patch (27, to be precise, which is exactly the number of lines in the file that have CRLF combination line endings).


> That way you'll checkout files as they are in the repo, and you'll commit them
> as they are on your HD.

That makes sense to me.


> The advice given everywhere I look on this seems to be geared towards forcing
> everyone to commit everything with LF line endings, then have git checkout the
> repo with the line endings that are appropriate for the OS being used. I don't
> think that's a great idea though..

Autoconversion of line endings seems a bit scary to me, since it sounds easy to end up making phantom changes where only the line endings have changed, although I suppose it would be ok if Git always got it right.

Comment 4

[Erik Vold]

(In reply to comment #3)
> (In reply to comment #2)
> > use: git config --global core.autocrlf false
> 
> I set this, but I still got a bunch of complaints about trailing whitespace
> when I applied the patch (27, to be precise, which is exactly the number of
> lines in the file that have CRLF combination line endings).

I think that is because of the git apply --white-space=warn default, so I think that if you use the following then you won't get the warnings:
git apply --white-space=nowarn

Comment 5

[Will Bamberg [:wbamberg]]

> > use: git config --global core.autocrlf false

Thanks for the clarification Eric, that makes sense to me.