mbox series

[0/2] Improvements to tests and docs for .gitattributes eol

Message ID 20220111021507.531736-1-sandals@crustytoothpaste.net (mailing list archive)
Headers show
Series Improvements to tests and docs for .gitattributes eol | expand

Message

brian m. carlson Jan. 11, 2022, 2:15 a.m. UTC
I was answering a question on StackOverflow recently about the
interaction between text=auto and eol, and someone pointed out to me
that what I had written, which was based on the documentation, was not
correct as of Git 2.10 (and more specifically 6523728499 ("convert:
unify the "auto" handling of CRLF", 2016-06-28)).

When I set out to document the behavior correctly, I ran into the fact
that the tests, where I looked for examples of how this behaves, didn't
have any tests for some of these cases, and so I had some trouble
documenting this clearly and accurately.  So this series basically just
adds some tests for existing behavior so we don't change it (and so I
could figure out how it works) and then updates the documentation
accordingly.

I tried to make the docs as specific as possible, since I needed them to
be specific and accurate here, and I felt like speaking affirmatively
about the behavior would be clearer than speaking negatively about the
behavior (I tried both).  I would of course be delighted to hear
suggestions on how this could be clearer or easier to understand.

I realize that 2.35.0-rc0 has just come out and so this won't be picked
up right away, which is fine, but I thought I'd send it out
nevertheless (mostly so I don't forget).

brian m. carlson (2):
  t0027: add tests for eol without text in .gitattributes
  docs: correct documentation about eol attribute

 Documentation/gitattributes.txt | 11 ++++++-----
 t/t0027-auto-crlf.sh            |  6 ++++++
 2 files changed, 12 insertions(+), 5 deletions(-)