add doc for g:sleuth_editorconfig_overrides

tpope · Jun 14, 2022 · a676a11 · a676a11
1 parent 1d25e8e
commit a676a11
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/doc/sleuth.txt b/doc/sleuth.txt
@@ -79,5 +79,15 @@ Sleuth forces |:filetype-indent-on| by default, which enables file-type
 specific indenting algorithms and is highly recommended. To opt out:
 >
         let g:sleuth_no_filetype_indent_on = 1
+<
+                                                *g:sleuth_editorconfig_overrides*
+The value can be a relative or absolute path, or an empty string to disable
+the file without replacing it.  On Windows, forward slashes must be used.
+
+This is a solution to the problem of a repository including a poorly
+considered .editorconfig that can't easily be changed.
+>
+    let g:sleuth_editorconfig_overrides = {
+          \ expand('~/bad/repo/.editorconfig'): '.editorconfig.mine'}
 <
  vim:tw=78:et:ft=help:norl: