Skip to content

Commit e8b03ed

Browse files
committed
Update whitespace readme
Add note about not making unnecessary affordances for Windows line endings.
1 parent 4cc558f commit e8b03ed

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

lints/lint_whitespace/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
# Whitespace Lint
22

33
This lint trims trailing whitespace and ensures there is exactly one newline at the end of files. It also ensures Unix file endings.
4+
5+
The default filter matches all text files (no 0 byte in the first 8000 bytes). It does not have special handling for Windows line endings (CRLF) - they will be modified to be LF. All text editors on Windows support Unix line endings (LF), so I recommend just switching your editors to use that, and configuring Git to fix them on commit like this:
6+
7+
git config --global core.autocrlf input

0 commit comments

Comments
 (0)