summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2020-08-29 16:05:49 +0100
committerw0rp <devw0rp@gmail.com>2020-08-29 16:05:49 +0100
commit7e0cdb53ecf9c94bb8777a57de8bf2aacca46b5d (patch)
treeed3a73c3128f80dd96e5f9409a64fdb1c4183226 /doc
parentbc3a843e102d4490b2476b53531807ab624417e7 (diff)
downloadale-7e0cdb53ecf9c94bb8777a57de8bf2aacca46b5d.zip
Fix #3247 - Use --always-make for make -n by default
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-c.txt16
-rw-r--r--doc/ale-cpp.txt1
2 files changed, 17 insertions, 0 deletions
diff --git a/doc/ale-c.txt b/doc/ale-c.txt
index fe28cf4a..b0d94b8e 100644
--- a/doc/ale-c.txt
+++ b/doc/ale-c.txt
@@ -8,6 +8,17 @@ runs either `clang`, or `gcc`. See |ale-c-cc|.
===============================================================================
Global Options
+g:ale_c_always_make *g:ale_c_always_make*
+ *b:ale_c_always_make*
+ Type: |Number|
+ Default: `has('unix') && !has('macunix')`
+
+ If set to `1`, use `--always-make` for `make`, which means that output will
+ always be parsed from `make` dry runs with GNU make. BSD `make` does not
+ support this option, so you probably want to turn this option off when using
+ a BSD variant.
+
+
g:ale_c_build_dir_names *g:ale_c_build_dir_names*
*b:ale_c_build_dir_names*
@@ -58,6 +69,11 @@ g:ale_c_parse_makefile *g:ale_c_parse_makefile*
set for C or C++ compilers. This can make it easier to determine the correct
build flags to use for different files.
+ NOTE: When using this option on BSD, you may need to set
+ |g:ale_c_always_make| to `0`, and `make -n` will not provide consistent
+ results if binaries have already been built, so use `make clean` when
+ editing your files.
+
WARNING: Running `make -n` automatically can execute arbitrary code, even
though it's supposed to be a dry run, so enable this option with care. You
might prefer to use the buffer-local version of the option instead with
diff --git a/doc/ale-cpp.txt b/doc/ale-cpp.txt
index 651b4160..17894e6e 100644
--- a/doc/ale-cpp.txt
+++ b/doc/ale-cpp.txt
@@ -10,6 +10,7 @@ Global Options
The following C options also apply to some C++ linters too.
+* |g:ale_c_always_make|
* |g:ale_c_build_dir_names|
* |g:ale_c_build_dir|
* |g:ale_c_parse_makefile|