From ad04b362229ea31a22069fa5e2a7ec10c831e623 Mon Sep 17 00:00:00 2001 From: 10sr <8.slashes@gmail.com> Date: Mon, 17 Dec 2018 16:24:27 +0900 Subject: [PATCH] Add document for editorconfig-trim-whitespaces-mode --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 0cd2cbbb..13e81dd5 100644 --- a/README.md +++ b/README.md @@ -176,6 +176,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.