branch: scratch/editorconfig-cc
commit 2ba007601a7e7d5edfd4aff3b2f42b337d8d7925
Author: 10sr <8.slas...@gmail.com>
Commit: Stefan Monnier <monn...@iro.umontreal.ca>
Add document for editorconfig-trim-whitespaces-mode
---
README.md | 18 ++++++++++++++++++
1 file changed, 18 insertions(+)
diff --git a/README.md b/README.md
index 9989969e46..9b540768a9 100644
--- a/README.md
+++ b/README.md
@@ -127,6 +127,24 @@ Possible known values are:
* `editorconfig-core-get-properties-hash`
* Always use built-in Emacs-Lisp implementation to get properties
+
+### `editorconfig-trim-whitespaces-mode`
+
+Buffer local minor-mode to use to trim trailing whitespaces.
+
+If set, enable that mode when `trim_trailing_whitespace` is set to true.
+Otherwise, use `delete-trailing-whitespace'.
+
+One possible value is
+[`ws-butler-mode`](https://github.com/lewang/ws-butler), with which
+only lines touched get trimmed. To use it, add following to yo
+init.el:
+
+``` emacs-lisp
+(setq editorconfig-trim-whitespaces-mode
+ 'ws-butler-mode)
+```
+
## Testing
Make and [CMake](https://cmake.org) must be installed to run the tests.
