summaryrefslogtreecommitdiff
path: root/doc/ale-cpp.txt
diff options
context:
space:
mode:
authorBjorn Neergaard <bjorn@neersighted.com>2018-11-29 14:57:35 -0700
committerBjorn Neergaard <bjorn@neersighted.com>2018-11-29 14:57:35 -0700
commitd2b0ae8108b2ee395d4eb43c49d68b322a023a30 (patch)
treebb8145e69bf1bcb8968b29cb1a68c47ceb83674d /doc/ale-cpp.txt
parentef641dda80f45cb979bc93c2513c6e10cbd8e42a (diff)
parent0a384a49d371838903d8401c5358ec60f3f4266d (diff)
downloadale-d2b0ae8108b2ee395d4eb43c49d68b322a023a30.zip
Merge branch 'master' into sridhars
Diffstat (limited to 'doc/ale-cpp.txt')
-rw-r--r--doc/ale-cpp.txt90
1 files changed, 89 insertions, 1 deletions
diff --git a/doc/ale-cpp.txt b/doc/ale-cpp.txt
index 8bd111e4..e1f64ab5 100644
--- a/doc/ale-cpp.txt
+++ b/doc/ale-cpp.txt
@@ -10,6 +10,7 @@ The following C options also apply to some C++ linters too.
* |g:ale_c_build_dir_names|
* |g:ale_c_build_dir|
* |g:ale_c_parse_makefile|
+* |g:ale_c_parse_compile_commands|
===============================================================================
@@ -32,6 +33,25 @@ g:ale_cpp_clang_options *g:ale_cpp_clang_options*
===============================================================================
+clangd *ale-cpp-clangd*
+
+g:ale_cpp_clangd_executable *g:ale_cpp_clangd_executable*
+ *b:ale_cpp_clangd_executable*
+ Type: |String|
+ Default: `'clangd'`
+
+ This variable can be changed to use a different executable for clangd.
+
+
+g:ale_cpp_clangd_options *g:ale_cpp_clangd_options*
+ *b:ale_cpp_clangd_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be changed to modify flags given to clangd.
+
+
+===============================================================================
clangcheck *ale-cpp-clangcheck*
`clang-check` will be run only when files are saved to disk, so that
@@ -83,7 +103,7 @@ overrides |g:ale_c_build_dir_names|.
g:ale_cpp_clangtidy_checks *g:ale_cpp_clangtidy_checks*
*b:ale_cpp_clangtidy_checks*
Type: |List|
- Default: `['*']`
+ Default: `[]`
The checks to enable for clang-tidy with the `-checks` argument.
@@ -119,6 +139,37 @@ g:ale_cpp_clangtidy_options *g:ale_cpp_clangtidy_options*
===============================================================================
+clazy *ale-cpp-clazy*
+
+g:ale_cpp_clazy_executable *g:ale_cpp_clazy_executable*
+ *b:ale_cpp_clazy_executable*
+ Type: |String|
+ Default: `'clazy-standalone'`
+
+ This variable can be changed to use a different executable for clazy.
+
+
+g:ale_cpp_clazy_checks *g:ale_cpp_clazy_checks*
+ *b:ale_cpp_clazy_checks*
+ Type: |List|
+ Default: `['level1']`
+
+ The checks to enable for clazy with the `-checks` argument.
+
+ All options will be joined with commas, and escaped appropriately for
+ the shell. The `-checks` flag can be removed entirely by setting this
+ option to an empty List.
+
+
+g:ale_cpp_clazy_options *g:ale_cpp_clazy_options*
+ *b:ale_cpp_clazy_options*
+ Type: |String|
+ Default: `''`
+
+ This variable can be changed to modify flags given to clazy.
+
+
+===============================================================================
cppcheck *ale-cpp-cppcheck*
g:ale_cpp_cppcheck_executable *g:ale_cpp_cppcheck_executable*
@@ -223,4 +274,41 @@ g:ale_cpp_gcc_options *g:ale_cpp_gcc_options*
===============================================================================
+uncrustify *ale-cpp-uncrustify*
+
+See |ale-c-uncrustify| for information about the available options.
+
+
+===============================================================================
+ccls *ale-cpp-ccls*
+
+g:ale_cpp_ccls_executable *g:ale_cpp_ccls_executable*
+ *b:ale_cpp_ccls_executable*
+ Type: |String|
+ Default: `'ccls'`
+
+ This variable can be changed to use a different executable for ccls.
+
+
+g:ale_cpp_ccls_init_options *g:ale_cpp_ccls_init_options*
+ *b:ale_cpp_ccls_init_options*
+ Type: |Dictionary|
+ Default: `{}`
+
+ This variable can be changed to customize ccls initialization options.
+ Example: >
+ {
+ \ 'cacheDirectory': '/tmp/ccls',
+ \ 'cacheFormat': 'binary',
+ \ 'diagnostics': {
+ \ 'onOpen': 0,
+ \ 'opChange': 1000,
+ \ },
+ \ }
+<
+ Visit https://github.com/MaskRay/ccls/wiki/Initialization-options for all
+ available options and explanations.
+
+
+===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: