Skip to content

Commit 71c61e0

Browse files
committed
Tweak the readme.
1 parent a879969 commit 71c61e0

File tree

2 files changed

+14
-6
lines changed

2 files changed

+14
-6
lines changed

plugin-gradle/README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1577,11 +1577,15 @@ spotless {
15771577
encoding 'Cp1252' // except java, which will be Cp1252
15781578
```
15791579

1580-
Line endings can also be set globally or per-format using the `lineEndings` property. Spotless supports four line ending modes: `UNIX`, `WINDOWS`, `MAC_CLASSIC`, `PLATFORM_NATIVE`, `GIT_ATTRIBUTES`, `GIT_ATTRIBUTES_FAST_ALLSAME` and `PRESERVE`. The default value is `GIT_ATTRIBUTES_FAST_ALLSAME`, and *we highly recommend that you* ***do not change*** *this value*. Git has opinions about line endings, and if Spotless and git disagree, then you're going to have a bad time. `FAST_ALLSAME` just means that Spotless can assume that every file being formatted has the same line endings ([more info](https://github.com/diffplug/spotless/pull/1838)).
1580+
Line endings can also be set globally or per-format using the `lineEndings` property. Spotless supports
15811581

1582-
You can easily set the line endings of different files using [a `.gitattributes` file](https://help.github.com/articles/dealing-with-line-endings/). Here's an example `.gitattributes` which sets all files to unix newlines: `* text eol=lf`.
1582+
- constant modes (`UNIX`, `WINDOWS`, `MAC_CLASSIC`)
1583+
- simple modes (`PLATFORM_NATIVE`, `PRESERVE`)
1584+
- and git-aware modes (`GIT_ATTRIBUTES`, `GIT_ATTRIBUTES_FAST_ALLSAME`)
1585+
1586+
The default value is `GIT_ATTRIBUTES_FAST_ALLSAME`, and *we highly recommend that you* ***do not change*** *this value*. Git has opinions about line endings, and if Spotless and git disagree, then you're going to have a bad time. `FAST_ALLSAME` just means that Spotless can assume that every file being formatted has the same line endings ([more info](https://github.com/diffplug/spotless/pull/1838)).
15831587
1584-
Use `PRESERVE` in order to keep the existing line endings of a file. This policy enforces that all line endings equal the first one of the according file (no matter which line delimiter it is).
1588+
You can easily set the line endings of different files using [a `.gitattributes` file](https://help.github.com/articles/dealing-with-line-endings/). Here's an example `.gitattributes` which sets all files to unix newlines: `* text eol=lf`.
15851589

15861590
<a name="custom"></a>
15871591
<a name="custom-steps"></a>

plugin-maven/README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1784,11 +1784,15 @@ Spotless uses UTF-8 by default, but you can use [any encoding which Java support
17841784
</configuration>
17851785
```
17861786

1787-
Line endings can also be set globally or per-format using the `lineEndings` property. Spotless supports four line ending modes: `UNIX`, `WINDOWS`, `MAC_CLASSIC`, `PLATFORM_NATIVE`, `GIT_ATTRIBUTES`, `GIT_ATTRIBUTES_FAST_ALLSAME` and `PRESERVE`. The default value is `GIT_ATTRIBUTES_FAST_ALLSAME`, and *we highly recommend that you* ***do not change*** *this value*. Git has opinions about line endings, and if Spotless and git disagree, then you're going to have a bad time. `FAST_ALLSAME` just means that Spotless can assume that every file being formatted has the same line endings ([more info](https://github.com/diffplug/spotless/pull/1838)).
1787+
Line endings can also be set globally or per-format using the `lineEndings` property. Spotless supports
17881788

1789-
You can easily set the line endings of different files using [a `.gitattributes` file](https://help.github.com/articles/dealing-with-line-endings/). Here's an example `.gitattributes` which sets all files to unix newlines: `* text eol=lf`.
1789+
- constant modes (`UNIX`, `WINDOWS`, `MAC_CLASSIC`)
1790+
- simple modes (`PLATFORM_NATIVE`, `PRESERVE`)
1791+
- and git-aware modes (`GIT_ATTRIBUTES`, `GIT_ATTRIBUTES_FAST_ALLSAME`)
17901792

1791-
Use `PRESERVE` in order to keep the existing line endings of a file. This policy enforces that all line endings equal the first one of the according file (no matter which line delimiter it is).
1793+
The default value is `GIT_ATTRIBUTES_FAST_ALLSAME`, and *we highly recommend that you* ***do not change*** *this value*. Git has opinions about line endings, and if Spotless and git disagree, then you're going to have a bad time. `FAST_ALLSAME` just means that Spotless can assume that every file being formatted has the same line endings ([more info](https://github.com/diffplug/spotless/pull/1838)).
1794+
1795+
You can easily set the line endings of different files using [a `.gitattributes` file](https://help.github.com/articles/dealing-with-line-endings/). Here's an example `.gitattributes` which sets all files to unix newlines: `* text eol=lf`.
17921796

17931797
<a name="enforceCheck"></a>
17941798

0 commit comments

Comments
 (0)