peter/spectre-meltdown-checker
1
0
Fork 0
mirror of https://github.com/speed47/spectre-meltdown-checker.git synced 2026-04-03 05:37:11 +02:00
Code Issues Projects Releases Wiki Activity

chore: update dev doc with check_CVE_* header exception

Browse Source
This commit is contained in:
Stéphane Lesimple
2026-04-02 22:09:09 +02:00
parent 3ea8e213ec
commit d644941a76
1 changed files with 1 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
DEVELOPMENT.md
View File

@@ -237,17 +237,14 @@ The file must contain exactly three functions:
############################### ###############################
# CVE-YYYY-NNNNN, Short Name, Complete Name # CVE-YYYY-NNNNN, Short Name, Complete Name
# CVE-YYYY-NNNNN SHORT_NAME (one-line description) - entry point
check_CVE_YYYY_NNNNN() { check_CVE_YYYY_NNNNN() {
check_cve 'CVE-YYYY-NNNNN' check_cve 'CVE-YYYY-NNNNN'
} }
# CVE-YYYY-NNNNN SHORT_NAME (one-line description) - Linux mitigation check
check_CVE_YYYY_NNNNN_linux() { check_CVE_YYYY_NNNNN_linux() {
# ... (see Step 3) # ... (see Step 3)
} }
# CVE-YYYY-NNNNN SHORT_NAME (one-line description) - BSD mitigation check
check_CVE_YYYY_NNNNN_bsd() { check_CVE_YYYY_NNNNN_bsd() {
if ! is_cpu_affected "$cve"; then if ! is_cpu_affected "$cve"; then
pvulnstatus "$cve" OK "your CPU vendor reported your CPU model as not affected" 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. - 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. - 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. - 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:** **Full example:**