From d644941a765118c0b8eced5c86768894374838c7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Lesimple?= Date: Thu, 2 Apr 2026 22:09:09 +0200 Subject: [PATCH] chore: update dev doc with check_CVE_* header exception --- DEVELOPMENT.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 6949098..0e3a12e 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -237,17 +237,14 @@ The file must contain exactly three functions: ############################### # CVE-YYYY-NNNNN, Short Name, Complete Name -# CVE-YYYY-NNNNN SHORT_NAME (one-line description) - entry point check_CVE_YYYY_NNNNN() { check_cve 'CVE-YYYY-NNNNN' } -# CVE-YYYY-NNNNN SHORT_NAME (one-line description) - Linux mitigation check check_CVE_YYYY_NNNNN_linux() { # ... (see Step 3) } -# CVE-YYYY-NNNNN SHORT_NAME (one-line description) - BSD mitigation check check_CVE_YYYY_NNNNN_bsd() { if ! is_cpu_affected "$cve"; then pvulnstatus "$cve" OK "your CPU vendor reported your CPU model as not affected" @@ -744,6 +741,7 @@ Every function must have a documentation header immediately above its definition - The `# Callers:` line is required for all `_`-prefixed functions. It documents which functions depend on this helper, making it safe to refactor. - Keep descriptions to one line when possible. If more context is needed, add continuation comment lines before the structured lines. - Parameter documentation uses `$1=name` format. Append `(optional, default X)` for optional parameters. +- **Exception**: `check_CVE_*` functions (`check_CVE_YYYY_NNNNN`, `_linux`, `_bsd`) are exempt from the documentation header requirement. They are self-explanatory, take no arguments, and live in dedicated `src/vulns/CVE-YYYY-NNNNN.sh` files whose line-3 header already describes the vulnerability. **Full example:**