summaryrefslogtreecommitdiff
path: root/AGENTS.md
diff options
context:
space:
mode:
authorClaude <[email protected]>2026-06-05 07:30:23 +0000
committerClaude <[email protected]>2026-06-05 07:30:23 +0000
commitc3b4ef03aa26f29d5ab28313130b677c1ea00c51 (patch)
treef0663d63894f4c79016b230f5fa5a660e5427e43 /AGENTS.md
parentde756315ec43bdca54599a7d0ba772fa7fbf7cf6 (diff)
Compact pvs skill; fix PVS-Studio -S/--dump-files docs in AGENTS.md
The AGENTS.md '-S src/foo.c' example was inaccurate: -S takes a plaintext file listing source paths, not paths directly. Drop --dump-files from the documented commands (it scatters .PVS-Studio.i/.cfg dumps across the tree; FP-debugging only) and reference the new pvs skill. https://claude.ai/code/session_015inWmFhRYSq17CxMukdoqX
Diffstat (limited to 'AGENTS.md')
-rw-r--r--AGENTS.md16
1 files changed, 10 insertions, 6 deletions
diff --git a/AGENTS.md b/AGENTS.md
index 5c9908d19..8ea650ecb 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -153,28 +153,32 @@ Reports land in `cmake-metrics/<board>/metrics_compare.md` (per-board) and `cmak
## Static Analysis (PVS-Studio)
-Requires `compile_commands.json` (CMake `-DCMAKE_EXPORT_COMPILE_COMMANDS=ON`).
+Requires `compile_commands.json` (CMake `-DCMAKE_EXPORT_COMPILE_COMMANDS=ON`). The
+`pvs` skill (`.claude/skills/pvs/SKILL.md`) wraps the build + analyze flow for a
+board; the commands below are the underlying steps.
```bash
# Whole project:
pvs-studio-analyzer analyze \
-f examples/cmake-build-raspberry_pi_pico/compile_commands.json \
-R .PVS-Studio/.pvsconfig \
- -o pvs-report.log -j12 --dump-files \
+ -o pvs-report.log -j12 \
--misra-c-version 2023 --misra-cpp-version 2008 --use-old-parser
-# Specific files (add one or more `-S <file>`):
+# Specific files: -S takes a plaintext list (one path per line), not paths directly:
+printf 'src/foo.c\nsrc/bar.c\n' > files.txt
pvs-studio-analyzer analyze \
-f examples/cmake-build-raspberry_pi_pico/compile_commands.json \
-R .PVS-Studio/.pvsconfig \
- -S src/foo.c -S src/bar.c \
- -o pvs-report.log -j12 --dump-files \
+ -S files.txt \
+ -o pvs-report.log -j12 \
--misra-c-version 2023 --misra-cpp-version 2008 --use-old-parser
plog-converter -a GA:1,2 -t errorfile pvs-report.log # view results
```
-Takes ~10-30 s.
+Takes ~10-30 s. (`--dump-files` adds preprocessed `.PVS-Studio.i/.cfg` dumps next
+to every source for false-positive debugging — omit it for normal runs.)
## Validation After Changes