Re: [PATCH v3 2/4] gitfaq: give advice on using eol attribute in gitattributes

From: brian m. carlson <sandals@crustytoothpaste.net>
Date: Jul 4, 2024, 21:10 UTC
Message-ID: <ZocPrtrOVTqSeUTY@tapette.crustytoothpaste.net>
In-Reply-To: <xmqqcynt91fe.fsf@gitster.g>

On 2024-07-04 at 05:22:13, Junio C Hamano wrote:

Show 24 quoted lines

> "brian m. carlson" <sandals@crustytoothpaste.net> writes:
> > +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
> 
> "this" being ... Not what gets stored in the object database but
> what is done to the working tree.
> 
> What is being "overridden" is that the earlier two mentioned here
> are configuration variables that apply to _all_ text files in
> general, and the attribute mechanism is a way to give settings that
> are more tailored for each path.  I think the reason I found the
> above a bit hard to understand when I read it for the first time was
> because it didn't "click" that this paragraph was about configuration
> giving the general default and attributes overriding it.  Perhaps...
> 
>     ... are used in the repository.  The `core.autocrlf` and
>     `core.eol` configuration variables specify what line-ending
>     convention is followed when any text file is checked out.  You
>     can also use the `eol` attribute (e.g., "eol=crlf") to override
>     which files get what line-ending treatment.
> 
> or something?

Sure, that sounds like a nice improvement.

> > +have that ending in the working tree (e.g., for functionality reasons).
> 
> I'd strike "(e.g., for functionality reasons)" out, as the next
> paragraph makes it sufficiently clear.

Sure, I can do that.

-- 
brian m. carlson (they/them or he/him)
Toronto, Ontario, CA