summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2020-08-09 20:13:21 +0100
committerw0rp <devw0rp@gmail.com>2020-08-09 20:13:21 +0100
commitbf3c3e943880876e2a8f3bf04c26f365c63fd0ad (patch)
tree4df9b4b1bb7b40bd102c7246abe0311807304b19 /README.md
parent9e1f511003142db5a1ba05815dc8d40f753c080b (diff)
downloadale-bf3c3e943880876e2a8f3bf04c26f365c63fd0ad.zip
#3276 - Update README for make -n changes
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 10 insertions, 6 deletions
diff --git a/README.md b/README.md
index 6d1f8dd9..ffc6dd19 100644
--- a/README.md
+++ b/README.md
@@ -816,12 +816,16 @@ setting. Consult the documentation for that setting for more information.
`b:ale_linters` can be used to select which tools you want to run, say if you
want to use only `gcc` for one project, and only `clang` for another.
-ALE will attempt to parse `make -n` when a `Makefile` is found or load the flags
-for files from `compile_commands.json` files. See `:help g:ale_c_parse_makefile`
-and `:help g:ale_c_parse_compile_commands` for more information. See Clang's
-documentation for [compile_commands.json files](https://clang.llvm.org/docs/JSONCompilationDatabase.html).
-You should strongly consider generating them in your builds, which is easy to
-do with CMake.
+ALE will attempt to parse `compile_commands.json` files to discover compiler
+flags to use when linting code. See `:help g:ale_c_parse_compile_commands` for
+more information. See Clang's documentation for
+[compile_commands.json files](https://clang.llvm.org/docs/JSONCompilationDatabase.html).
+You should strongly consider generating them in your builds, which is easy to do
+with CMake.
+
+You can also configure ALE to automatically run `make -n` to run dry runs on
+`Makefile`s to discover compiler flags. This can execute arbitrary code, so the
+option is disabled by default. See `:help g:ale_c_parse_makefile`.
You may also configure buffer-local settings for linters with project-specific
vimrc files. [local_vimrc](https://github.com/LucHermitte/local_vimrc) can be