summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBart Libert <lapino@gmail.com>2016-10-20 13:30:45 +0200
committerw0rp <w0rp@users.noreply.github.com>2016-10-20 12:30:45 +0100
commita34fb0a6a7f920cd4d9a3e50facf51f8d5defea2 (patch)
tree74b97ad98e528be7df75259275ada10451769b12 /doc
parentacb209aa11960211718b7cb9b55688e5be1adc63 (diff)
downloadale-a34fb0a6a7f920cd4d9a3e50facf51f8d5defea2.zip
Add support for cppcheck (#126)
* Add support for cppcheck * Fix vint error in cppcheck handler * Add vader test for CppCheck format handler
Diffstat (limited to 'doc')
-rw-r--r--doc/ale.txt28
1 files changed, 26 insertions, 2 deletions
diff --git a/doc/ale.txt b/doc/ale.txt
index 3400ed35..ab6f6093 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -21,6 +21,8 @@ CONTENTS *ale-contents*
4.9. shellcheck............................|ale-linter-options-shellcheck|
4.10. vint..................................|ale-linter-options-vint|
4.11. luacheck..............................|ale-linter-options-luacheck|
+ 4.12. c-cppcheck............................|ale-linter-options-c-cppcheck|
+ 4.13. cpp-cppcheck..........................|ale-linter-options-cpp-cppcheck|
5. API........................................|ale-api|
6. Special Thanks.............................|ale-special-thanks|
7. Contact....................................|ale-contact|
@@ -50,8 +52,8 @@ The following languages and tools are supported.
* Bash: 'shell' (-n flag), 'shellcheck'
* Bourne Shell: 'shell' (-n flag), 'shellcheck'
-* C: 'gcc'
-* C++ (filetype cpp): 'gcc'
+* C: 'cppcheck', 'gcc'
+* C++ (filetype cpp): 'cppcheck', 'gcc'
* CoffeeScript: 'coffee', 'coffelint'
* CSS: 'csslint'
* Cython (pyrex filetype): 'cython'
@@ -505,6 +507,28 @@ g:ale_lua_luacheck_executable *g:ale_lua_luacheck_executable*
This variable can be changed to change the path to luacheck.
+-------------------------------------------------------------------------------
+4.12. c-cppcheck *ale-linter-options-c-cppcheck*
+
+g:ale_c_cppcheck_options *g:ale_c_cppcheck_options*
+
+ Type: |String|
+ Default: `'--enable=style'`
+
+ This variable can be changed to modify flags given to cppcheck.
+
+
+-------------------------------------------------------------------------------
+4.13. cpp-cppcheck *ale-linter-options-cpp-cppcheck*
+
+g:ale_cpp_cppcheck_options *g:ale_cpp_cppcheck_options*
+
+ Type: |String|
+ Default: `'--enable=style'`
+
+ This variable can be changed to modify flags given to cppcheck.
+
+
===============================================================================
5. API *ale-api*