summaryrefslogtreecommitdiff
path: root/doc/ale-cpp.txt
diff options
context:
space:
mode:
authorGagbo <Gagbo@users.noreply.github.com>2017-06-24 17:10:04 +0200
committerw0rp <w0rp@users.noreply.github.com>2017-06-24 16:10:04 +0100
commitdc647fcc7fc716c3f5488fc7af115e64243e2021 (patch)
treed21953ba229b05fe2bef68d75b936a1af7742732 /doc/ale-cpp.txt
parente98560a349f3381c8fc6ecb6bf149c337dcf17be (diff)
downloadale-dc647fcc7fc716c3f5488fc7af115e64243e2021.zip
Add clangcheck Linter to cpp (#686)
Add a clangcheck linter
Diffstat (limited to 'doc/ale-cpp.txt')
-rw-r--r--doc/ale-cpp.txt37
1 files changed, 32 insertions, 5 deletions
diff --git a/doc/ale-cpp.txt b/doc/ale-cpp.txt
index 27e7fe0b..0b9b3ae1 100644
--- a/doc/ale-cpp.txt
+++ b/doc/ale-cpp.txt
@@ -45,6 +45,29 @@ g:ale_cpp_clang_options *g:ale_cpp_clang_options*
-------------------------------------------------------------------------------
+clangcheck *ale-cpp-clangcheck*
+
+`clang-check` will be run only when files are saved to disk, so that
+`compile_commands.json` files can be used. It is recommended to use this
+linter in combination with `compile_commands.json` files.
+Therefore, `clang-check` linter reads the options |g:ale_c_build_dir| and
+|g:ale_c_build_dir_names|. Also, setting |g:ale_c_build_dir| actually
+overrides |g:ale_c_build_dir_names|.
+
+
+g:ale_cpp_clangcheck_options *g:ale_cpp_clangcheck_options*
+ *b:ale_cpp_clangcheck_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be changed to modify flags given to clang-check.
+
+ This variable should not be set to point to build subdirectory with
+ `-p path/to/build` option, as it is handled by the |g:ale_c_build_dir|
+ option.
+
+
+-------------------------------------------------------------------------------
clangtidy *ale-cpp-clangtidy*
`clang-tidy` will be run only when files are saved to disk, so that
@@ -73,11 +96,15 @@ g:ale_cpp_clangtidy_options *g:ale_cpp_clangtidy_options*
This variable can be changed to modify flags given to clang-tidy.
- Setting this variable to a non-empty string will cause the `--` argument
- to be passed to `clang-tidy`, which will mean that detection of
- `compile_commands.json` files for compile command databases will be
- disabled. Only set this option if you want to control compiler flags
- entirely manually.
+ - Setting this variable to a non-empty string,
+ - and working in a buffer where no compilation database is found using
+ |g:ale_c_build_dir_names| or |g:ale_c_build_dir|,
+ will cause the `--` argument to be passed to `clang-tidy`, which will mean
+ that detection of `compile_commands.json` files for compile command
+ databases will be disabled.
+ Only set this option if you want to control compiler flags
+ entirely manually, and no `compile_commands.json` file is in one
+ of the |g:ale_c_build_dir_names| directories of the project tree.
-------------------------------------------------------------------------------