summaryrefslogtreecommitdiff
path: root/doc/ale-cpp.txt
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2017-08-30 22:08:41 +0100
committerw0rp <devw0rp@gmail.com>2017-08-30 22:08:41 +0100
commited9cdca127abea30ffaf5df0ba1cc5ffe5c5a657 (patch)
tree70ab2d42759b407f64045a2bc53c6be2bb41a332 /doc/ale-cpp.txt
parentfca77266bde1ed48b20ec37bab81d05f826e1e6c (diff)
parente4a6da936d68310a5bf4d744f2275e57e0a62724 (diff)
downloadale-ed9cdca127abea30ffaf5df0ba1cc5ffe5c5a657.zip
Merge remote-tracking branch 'randrej/master' into c-clang-tidy
Diffstat (limited to 'doc/ale-cpp.txt')
-rw-r--r--doc/ale-cpp.txt28
1 files changed, 2 insertions, 26 deletions
diff --git a/doc/ale-cpp.txt b/doc/ale-cpp.txt
index 2ece6843..685bb8dc 100644
--- a/doc/ale-cpp.txt
+++ b/doc/ale-cpp.txt
@@ -5,33 +5,9 @@ ALE C++ Integration *ale-cpp-options*
===============================================================================
Global Options
-g:ale_c_build_dir_names *g:ale_c_build_dir_names*
- *b:ale_c_build_dir_names*
+The |g:ale_c_build_dir_names| and |g:ale_c_build_dir| also apply to some C++
+linters too.
- Type: |List|
- Default: `['build', 'bin']`
-
- A list of directory names to be used when searching upwards from cpp
- files to discover compilation databases with. For directory named `'foo'`,
- ALE will search for `'foo/compile_commands.json'` in all directories on and above
- the directory containing the cpp file to find path to compilation database.
- This feature is useful for the clang tools wrapped around LibTooling (namely
- here, clang-tidy)
-
-
-g:ale_c_build_dir *g:ale_c_build_dir*
- *b:ale_c_build_dir*
-
- Type: |String|
- Default: `''`
-
- A path to the directory containing the `compile_commands.json` file to use
- with c-family linters. Usually setting this option to a non-empty string
- will override the |g:ale_c_build_dir_names| option to impose a compilation
- database (it can be useful if multiple builds are in multiple build
- subdirectories in the project tree).
- This feature is also most useful for the clang tools linters, wrapped
- aroung LibTooling (namely clang-tidy here)
===============================================================================
clang *ale-cpp-clang*