summaryrefslogtreecommitdiff
path: root/doc
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 /doc
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 'doc')
-rw-r--r--doc/ale-c.txt14
1 files changed, 9 insertions, 5 deletions
diff --git a/doc/ale-c.txt b/doc/ale-c.txt
index efc26f93..53c141b3 100644
--- a/doc/ale-c.txt
+++ b/doc/ale-c.txt
@@ -37,7 +37,7 @@ g:ale_c_build_dir *g:ale_c_build_dir*
g:ale_c_parse_compile_commands *g:ale_c_parse_compile_commands*
*b:ale_c_parse_compile_commands*
Type: |Number|
- Default: `0`
+ Default: `1`
If set to `1`, ALE will parse `compile_commands.json` files to automatically
determine flags for C or C++ compilers. ALE will first search for the
@@ -45,19 +45,23 @@ g:ale_c_parse_compile_commands *g:ale_c_parse_compile_commands*
`compile_commands.json` files in the directories for
|g:ale_c_build_dir_names|.
- If |g:ale_c_parse_makefile| or |b:ale_c_parse_makefile| is set to `1`, the
- output of `make -n` will be preferred over `compile_commands.json` files.
-
g:ale_c_parse_makefile *g:ale_c_parse_makefile*
*b:ale_c_parse_makefile*
Type: |Number|
- Default: `0`
+ Default: `1`
If set to `1`, ALE will run `make -n` to automatically determine flags to
set for C or C++ compilers. This can make it easier to determine the correct
build flags to use for different files.
+ You might want to disable this option if `make -n` takes too long to run for
+ projects you work on.
+
+ If |g:ale_c_parse_compile_commands| or |b:ale_c_parse_compile_commands| is
+ set to `1`, flags taken from `compile_commands.json` will be preferred over
+ `make -n` output.
+
===============================================================================
astyle *ale-c-astyle*