| Message ID | 20211107225525.431138-3-sandals@crustytoothpaste.net (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | Additional FAQ entries | expand |
On Sun, Nov 7, 2021 at 5:55 PM brian m. carlson <sandals@crustytoothpaste.net> wrote: > In the FAQ, we tell people how to use the text attribute, but we fail to > explain what to do with the eol attribute. As we ourselves have > noticed, most shell implementations do not care for carriage returns, > and as such, people will practically always want them to use LF endings. > Similar things can be said for batch files on Windows, except with CRLF > endings. > > Since these are common things to have in a repository, let's help users > make a good decision by recommending that they use the gitattributes > file to correctly check out the endings. > [...] > Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net> > --- > diff --git a/Documentation/gitfaq.txt b/Documentation/gitfaq.txt > @@ -469,14 +470,25 @@ references, URLs, and hashes stored in the repository. > +With text files, Git will generally ensure that LF endings are used in the > +repository, and will honor `core.autocrlf` and `core.eol` to decide what options > +to use when checking files out. You can also override this by specifying a > +particular line ending such as `eol=lf` or `eol=crlf` if those files must always > +have that ending in the working tree (e.g., for functionality reasons). > ++ > +For example, the following might be appropriate in some projects: > + > ---- > # By default, guess. > * text=auto > # Mark all C files as text. > *.c text > +# Ensure all shell files end up with LF endings and all batch files end up > +# with CRLF endings in the working tree and both end up with LF in the repo. > +*.sh text eol=lf > +*.bat text eol=crlf > # Mark all JPEG files as binary. > *.jpg binary > ---- I like the concrete explanation in the commit message of why `.sh` and `.bat` files need to be configured specially, and was expecting that quite useful information to be repeated here in the body. That does seem exactly like what someone would come to the FAQ searching for, and even though the above content hints at it, the hint may be just vague enough to be overlooked. Consequently, I'm wondering if it ought to be spelled out more explicitly here. In particular, if we give examples of actual error messages people might encounter when attempting to run a CRLF shell script or an LF batch file, that would really give a FAQ searcher/reader something to latch onto when trying to solve a problem. This could be done as a lead-in paragraph immediately before the "For example, the following...". Also, following v1 review, I think you had intended[1]: s/end up with/have/ [1]: https://lore.kernel.org/git/YW9wgbN%2Fb8NkVp4z@camp.crustytoothpaste.net/
On 2021-11-07 at 23:48:00, Eric Sunshine wrote: > I like the concrete explanation in the commit message of why `.sh` and > `.bat` files need to be configured specially, and was expecting that > quite useful information to be repeated here in the body. That does > seem exactly like what someone would come to the FAQ searching for, > and even though the above content hints at it, the hint may be just > vague enough to be overlooked. Consequently, I'm wondering if it ought > to be spelled out more explicitly here. In particular, if we give > examples of actual error messages people might encounter when > attempting to run a CRLF shell script or an LF batch file, that would > really give a FAQ searcher/reader something to latch onto when trying > to solve a problem. This could be done as a lead-in paragraph > immediately before the "For example, the following...". I think that we could definitely add some text here to explain why one would want to use this, providing an example. > Also, following v1 review, I think you had intended[1]: s/end up with/have/ I will fix that in v3. Thanks for the reminder.
diff --git a/Documentation/gitfaq.txt b/Documentation/gitfaq.txt index 5c21951f7b..ae1b526565 100644 --- a/Documentation/gitfaq.txt +++ b/Documentation/gitfaq.txt @@ -406,8 +406,9 @@ I'm on Windows and git diff shows my files as having a `^M` at the end.:: + You can store the files in the repository with Unix line endings and convert them automatically to your platform's line endings. To do that, set the -configuration option `core.eol` to `native` and see the following entry for -information about how to configure files as text or binary. +configuration option `core.eol` to `native` and see +<<recommended-storage-settings,the question on recommended storage settings>> +for information about how to configure files as text or binary. + You can also control this behavior with the `core.whitespace` setting if you don't wish to remove the carriage returns from your line endings. @@ -469,14 +470,25 @@ references, URLs, and hashes stored in the repository. + We also recommend setting a linkgit:gitattributes[5] file to explicitly mark which files are text and which are binary. If you want Git to guess, you can -set the attribute `text=auto`. For example, the following might be appropriate -in some projects: +set the attribute `text=auto`. ++ +With text files, Git will generally ensure that LF endings are used in the +repository, and will honor `core.autocrlf` and `core.eol` to decide what options +to use when checking files out. You can also override this by specifying a +particular line ending such as `eol=lf` or `eol=crlf` if those files must always +have that ending in the working tree (e.g., for functionality reasons). ++ +For example, the following might be appropriate in some projects: + ---- # By default, guess. * text=auto # Mark all C files as text. *.c text +# Ensure all shell files end up with LF endings and all batch files end up +# with CRLF endings in the working tree and both end up with LF in the repo. +*.sh text eol=lf +*.bat text eol=crlf # Mark all JPEG files as binary. *.jpg binary ----
In the FAQ, we tell people how to use the text attribute, but we fail to explain what to do with the eol attribute. As we ourselves have noticed, most shell implementations do not care for carriage returns, and as such, people will practically always want them to use LF endings. Similar things can be said for batch files on Windows, except with CRLF endings. Since these are common things to have in a repository, let's help users make a good decision by recommending that they use the gitattributes file to correctly check out the endings. In addition, let's correct the cross-reference to this question, which originally referred to "the following entry", even though a new entry has been inserted in between. The cross-reference notation should prevent this from occurring and provide a link in formats, such as HTML, which support that. Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net> --- Documentation/gitfaq.txt | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-)