aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc/quickfix.txt
diff options
context:
space:
mode:
authorChristian Clason <c.clason@uni-graz.at>2024-10-05 17:41:15 +0200
committerChristian Clason <c.clason@uni-graz.at>2024-10-07 19:19:15 +0200
commit4ea0f1ec23eb74fb26b7137cdd83af3b0539f3be (patch)
tree7543fef6bceff29488e13f286e0bfd326fa7b63e /runtime/doc/quickfix.txt
parent61f1b091ea97793f9b644cebf6c84cf6bbb4f0bc (diff)
downloadrneovim-4ea0f1ec23eb74fb26b7137cdd83af3b0539f3be.tar.gz
rneovim-4ea0f1ec23eb74fb26b7137cdd83af3b0539f3be.tar.bz2
rneovim-4ea0f1ec23eb74fb26b7137cdd83af3b0539f3be.zip
vim-patch:af449f6: runtime(compiler): add cppcheck linter compiler plugin
closes: vim/vim#15804 https://github.com/vim/vim/commit/af449f69c7cc9f0ffafaa6e0d028dccd1c358763 Co-authored-by: Konfekt <Konfekt@users.noreply.github.com>
Diffstat (limited to 'runtime/doc/quickfix.txt')
-rw-r--r--runtime/doc/quickfix.txt26
1 files changed, 26 insertions, 0 deletions
diff --git a/runtime/doc/quickfix.txt b/runtime/doc/quickfix.txt
index 61ef0c8ef3..63109bdaf3 100644
--- a/runtime/doc/quickfix.txt
+++ b/runtime/doc/quickfix.txt
@@ -1264,6 +1264,32 @@ For writing a compiler plugin, see |write-compiler-plugin|.
Use the |compiler-make| plugin to undo the effect of a compiler plugin.
+CPPCHECK *quickfix-cppcheck* *compiler-cppcheck*
+
+Use g/b:`c_cppcheck_params` to set cppcheck parameters. The global
+settings by default include
+
+- `--verbose`: Enables verbose output.
+- `--force`: Forces checking of all configurations.
+- `--inline-suppr`: Allows inline suppressions.
+- `--enable=...`: Enables specific checks like warnings, style, performance,
+ portability, information, and missing includes.
+- `-j`: Utilizes multiple processors if available, determined by the
+ `getconf` command if available (requires omitting the unusedFunction check)
+
+For C++ files (`filetype == 'cpp'`), the `--language=c++` option is added to
+ensure Cppcheck treats the file as C++.
+
+If compile_commands.json is present in the current directory, it is added as a
+`--project` parameter to the command line. Otherwise, by default the
+directories in &path are passed as include directories. These can be set by
+g/b:`c_cppcheck_includes` as a list of `-I` flags. Tim Pope's vim-apathy
+plug-in [0] can expand &path. To also append the folders in a git repo use >
+
+ let &l:path = join(systemlist('git ls-tree -d --name-only -r HEAD'), ',')
+
+[0] https://github.com/tpope/vim-apathy
+
DOTNET *compiler-dotnet*
The .NET CLI compiler outputs both errors and warnings by default. The output