summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2020-08-09 04:19:14 +0100
committerw0rp <devw0rp@gmail.com>2020-08-09 04:23:32 +0100
commitaffeed7a87ce54aff9506c0069da1f9f23e3dd01 (patch)
tree8146029bc8f8c7d710a358fdc724da0b34b21dd1 /README.md
parent681ca5fee8612aae5fdcf032d7d12992d1f60a3e (diff)
downloadale-affeed7a87ce54aff9506c0069da1f9f23e3dd01.zip
Enable C flag parsing by default
The options for parsing `make -n` and `compile_commands.json` flags are now enabled by default, so people can start getting better flags for their files by default. `compile_commands.json` flags are now preferred over `make -n` results, to make the options work better by default.
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
index ad957bcb..6d1f8dd9 100644
--- a/README.md
+++ b/README.md
@@ -816,6 +816,13 @@ 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.
+
You may also configure buffer-local settings for linters with project-specific
vimrc files. [local_vimrc](https://github.com/LucHermitte/local_vimrc) can be
used for executing local vimrc files which can be shared in your project.