branch: scratch/editorconfig-cc
commit b42ae4c89c10154414130fed3b0398c7426506c0
Author: 10sr <8.slas...@gmail.com>
Commit: Stefan Monnier <monn...@iro.umontreal.ca>
Add doc about lsp-mode (#266)
* WIP Add doc about lsp-mode
* Update README
---
README.md | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/README.md b/README.md
index ef1a603f70..0a1c73c7bd 100644
--- a/README.md
+++ b/README.md
@@ -140,6 +140,16 @@ Typically it will occur when the major-mode is not defined
using
Please feel free to submit issues if you find such modes!
+### `editorconfig-format-buffer` does not work well with lsp-mode
+
+By default, [lsp-mode][] configures indent-region-function so that Emacs uses
+language servers' `textDocument/rangeFormatting` request to format text in
+buffers.
+So EditorConfig settings are ignored unless language servers
+themselves support loading configs from `.editorconfig`.
+
+To avoid this behavior ad-hocly, set `lsp-enable-indentation` to nil.
+
@@ -184,3 +194,4 @@ with this program. If not, see
<http://www.gnu.org/licenses/>.
[EditorConfig C Core]: https://github.com/editorconfig/editorconfig-core-c
[properties]: https://editorconfig.org/#supported-properties
[CMake]: https://cmake.org
+[lsp-mode]: https://github.com/emacs-lsp/lsp-mode
