summaryrefslogtreecommitdiff
path: root/doc/ale-c.txt
diff options
context:
space:
mode:
authorChristian-Gibbons <cgibbons@gmu.edu>2018-02-25 09:11:04 -0500
committerw0rp <w0rp@users.noreply.github.com>2018-02-25 14:11:04 +0000
commit82f8a04e18000bc3311340f820edfc98005e99a9 (patch)
tree07a3c9fd28f1e9dd3b4d6a4b8ed66dec33f366b6 /doc/ale-c.txt
parent478a2883a6c75e888bce2b0e7c800d5d8990f29e (diff)
downloadale-82f8a04e18000bc3311340f820edfc98005e99a9.zip
New linter: Flawfinder (#1361)
* Flawfinder support added for C and C++ A minor modification to gcc handler was made to support flawfinder's single-line output format that does not have a space following the colon denoting the warning level. gcc handler still passes its Vader tests after this modification. * Documentation fixes * Revert documentation regression * Added Flawfinder to table of contents * Removed trailing whitespace * Follow ALE conventions better Added additional documentation and Vader tests
Diffstat (limited to 'doc/ale-c.txt')
-rw-r--r--doc/ale-c.txt27
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/ale-c.txt b/doc/ale-c.txt
index fc2c45c7..62445de2 100644
--- a/doc/ale-c.txt
+++ b/doc/ale-c.txt
@@ -144,6 +144,33 @@ g:ale_c_cppcheck_options *g:ale_c_cppcheck_options*
===============================================================================
+flawfinder *ale-c-flawfinder*
+
+g:ale_c_flawfinder_executable *g:ale_c_flawfinder_executable*
+ *g:ale_c_flawfinder_executable*
+ Type: |String|
+ Default: `'flawfinder'`
+
+ This variable can be changed to use a different executable for flawfinder.
+
+
+g:ale_c_flawfinder_minlevel *g:ale_c_flawfinder_minlevel*
+ *b:ale_c_flawfinder_minlevel*
+ Type: |Number|
+ Default: `1`
+
+ This variable can be changed to ignore risks under the given risk threshold.
+
+
+g:ale_c_flawfinder_options *g:ale-c-flawfinder*
+ *b:ale-c-flawfinder*
+ Type: |String|
+ Default: `''`
+
+ This variable can be used to pass extra options into the flawfinder command.
+
+
+===============================================================================
gcc *ale-c-gcc*
g:ale_c_gcc_executable *g:ale_c_gcc_executable*