Recently I came across the following entry in a .gitattributes file:
"* text=auto !eol"
What does !eol do?
Recently I came across the following entry in a .gitattributes file:
"* text=auto !eol"
What does !eol do?
Git has 2 attributes that deal with end-of-lines:
Documentation says:
This attribute enables and controls end-of-line normalization. When a text file is normalized, its line endings are converted to LF in the repository
This effectively means that when you commit to the repo, it will convert line-endings to LF
eolDocumentation says:
This attribute sets a specific line-ending style to be used in the working directory. It enables end-of-line normalization without any content checks, effectively setting the text attribute.
So while the text attribute affects how the file will look like IN THE REPO, eol affects how the file looks like in the working directory.
Now, an attribute can have 4 states:
set with no value
example: * text
unset
example: * -text
set with specific value
example: * text=auto
unspecified
example: * !text
So, * text=auto !eol means this:
All files have the attribute text set to auto and the eol attribute unspecified. Reading the documentation we find out that text=auto means that you let Git decide if a file is text and if it is it will normalize it (set line-endings in the repo to LF).
!eol means that the attribute eol is set to unspecified explicitly. In this case it is the same as not specifying it at all, instructing Git to look at the core.autocrlf and core.eol configuration settings to see how to deal with line-endings in the working directory. Note this:
The
core.eolconfiguration variable controls which line endings Git will use for normalized files in your working directory; the default is to use the native line ending for your platform, or CRLF ifcore.autocrlfis set.
But you would use !eol in a situation like the following:
* text=auto eol=crlf
test.txt !eol
basically overriding the eol attribute from CRLF to unspecified for test.txt. This means that for all files except test.txt, Git will convert line-endings to CRLF on checkout. For test.txt Git will defer to the core.autocrlf and core.eol configuration settings so on any given system the line-ending may be either LF or CRLF.
* text=auto !eol
implies:
It basically disables eol according to the documentation:
Sometimes you would need to override an setting of an attribute for a path to Unspecified state. This can be done by listing the name of the attribute prefixed with an exclamation point !.
eol does the following:
This attribute sets a specific line-ending style to be used in the working directory. It enables end-of-line normalization without any content checks, effectively setting the text attribute.
Short version:
If Git decides that the content is text, its line endings are normalized to LF on checkin. Revert any explicit eol setting in some nested .gitattributes file.
See man gitattributes:
Each line in gitattributes file is of form:
pattern attr1 attr2 ...
Sometimes you would need to override an setting of an attribute for a path to
Unspecified state. This can be done by listing the name of the attribute
prefixed with an exclamation point !.
text
This attribute enables and controls end-of-line normalization. When a text
file is normalized, its line endings are converted to LF in the
repository. To control what line ending style is used in the working
directory, use the eol attribute for a single file and the core.eol
configuration variable for all text files.
Set to string value "auto"
When text is set to "auto", the path is marked for automatic
end-of-line normalization. If Git decides that the content is text,
its line endings are normalized to LF on checkin.
eol
This attribute sets a specific line-ending style to be used in the working
directory. It enables end-of-line normalization without any content
checks, effectively setting the text attribute.