diff mbox series

[3/5] gitattributes: mark AsciiDoc files as LF-only

Message ID 20250120015603.1980991-4-sandals@crustytoothpaste.net (mailing list archive)
State New
Headers show
Series Convert AsciiDoc files to .adoc extension | expand

Commit Message

brian m. carlson Jan. 20, 2025, 1:56 a.m. UTC
In a future commit, we'll move the AsciiDoc documentation files to the
".adoc" extension rather than the extension ".txt".  We need these files
to use only LF because they are read by generate-cmdlist.sh using the
read builtin.

If we allow CRLF here, the CR at the end of the line is treated as part
of the synopsis, since a POSIX shell doesn't consider it special like
LF.  In that case, we generate synopsis strings in C that contain a CR,
which the compiler does not like because it believes that the double
quote string terminator is missing, and as a consequence, compilation
fails.

Because we rely on LF-only endings here to compile successfully and we
want Git to continue to be able to compile on Windows, mark these files
as LF-only in the .gitattributes file.

Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net>
---
 .gitattributes | 1 +
 1 file changed, 1 insertion(+)
diff mbox series

Patch

diff --git a/.gitattributes b/.gitattributes
index 158c3d45c4..b38cfd499b 100644
--- a/.gitattributes
+++ b/.gitattributes
@@ -8,6 +8,7 @@ 
 *.bat text eol=crlf
 CODE_OF_CONDUCT.md -whitespace
 /Documentation/**/*.txt text eol=lf
+/Documentation/**/*.adoc text eol=lf
 /command-list.txt text eol=lf
 /GIT-VERSION-GEN text eol=lf
 /mergetools/* text eol=lf