summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorfenuks <fenuks@protonmail.com>2018-08-24 10:52:33 +0100
committerw0rp <devw0rp@gmail.com>2018-08-24 10:52:33 +0100
commit9d7c48038cbbc696fe2d1e9c4b2d9eff2dd726c3 (patch)
treed034973b8a46a11c883bfbd775298e5162e80c46 /doc
parent08d141edfb9cacea2ddba347581e670f4a04caa7 (diff)
downloadale-9d7c48038cbbc696fe2d1e9c4b2d9eff2dd726c3.zip
Add clazy as cpp linter
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-cpp.txt31
-rw-r--r--doc/ale.txt3
2 files changed, 33 insertions, 1 deletions
diff --git a/doc/ale-cpp.txt b/doc/ale-cpp.txt
index c42d20a2..e582ae6e 100644
--- a/doc/ale-cpp.txt
+++ b/doc/ale-cpp.txt
@@ -139,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*
diff --git a/doc/ale.txt b/doc/ale.txt
index d1e6d0b0..2a78a9de 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -47,6 +47,7 @@ CONTENTS *ale-contents*
clangcheck..........................|ale-cpp-clangcheck|
clang-format........................|ale-cpp-clangformat|
clangtidy...........................|ale-cpp-clangtidy|
+ clazy...............................|ale-cpp-clazy|
cppcheck............................|ale-cpp-cppcheck|
cpplint.............................|ale-cpp-cpplint|
cquery..............................|ale-cpp-cquery|
@@ -351,7 +352,7 @@ Notes:
* Bash: `language-server`, `shell` (-n flag), `shellcheck`, `shfmt`
* Bourne Shell: `shell` (-n flag), `shellcheck`, `shfmt`
* C: `cppcheck`, `cpplint`!!, `clang`, `clangd`, `clangtidy`!!, `clang-format`, `cquery`, `flawfinder`, `gcc`
-* C++ (filetype cpp): `clang`, `clangd`, `clangcheck`!!, `clangtidy`!!, `clang-format`, `cppcheck`, `cpplint`!!, `cquery`, `flawfinder`, `gcc`
+* C++ (filetype cpp): `clang`, `clangd`, `clangcheck`!!, `clangtidy`!!, `clang-format`, `clazy`!!, `cppcheck`, `cpplint`!!, `cquery`, `flawfinder`, `gcc`
* CUDA: `nvcc`!!
* C#: `mcs`, `mcsc`!!
* Chef: `foodcritic`