From 6d9d1a0c5bf342421b25880616dade625239c9d2 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
 <41898282+github-actions[bot]@users.noreply.github.com>
Date: Thu, 2 Apr 2026 07:28:07 +0000
Subject: [PATCH] docs: document --help/--version flags and clarify CI gate
 enforcement

- docs/TECHNICAL.md: expand Argument Mode section to list --help/-h and
  --version/-v flags, which were added in the versioning commit but
  never reflected in the implementation docs.

- docs/CODE_QUALITY.md: add CI Gate Summary table to Notes on Enforcement
  section. Clarifies that make format-check is a hard CI gate (no
  continue-on-error) while checkpatch, cppcheck, and sparse are soft
  gates. A green CI run does not guarantee clean static-analysis output.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
---
 docs/CODE_QUALITY.md | 12 ++++++++++++
 docs/TECHNICAL.md    |  7 +++++++
 2 files changed, 19 insertions(+)

diff --git a/docs/CODE_QUALITY.md b/docs/CODE_QUALITY.md
index 98fd253..380afe7 100644
--- a/docs/CODE_QUALITY.md
+++ b/docs/CODE_QUALITY.md
@@ -138,3 +138,15 @@ git commit -m "Your message"
 - `make check` is a convenience aggregator for static analysis output.
 - Some tool invocations in the Makefile are best-effort (`|| true`) to keep developer flow smooth.
 - For release/PR readiness, treat any checkpatch/sparse/cppcheck findings as actionable and resolve them.
+
+### CI Gate Summary
+
+| Target | CI behavior | Notes |
+|---|---|---|
+| `make format-check` | **Hard gate** — CI fails if code is not formatted | Run `make format` before opening a PR |
+| `make checkpatch` | Soft gate (`continue-on-error`) | Findings are visible but do not block merge |
+| `make cppcheck` | Soft gate (`continue-on-error`) | Findings are visible but do not block merge |
+| `make sparse` | Soft gate (`continue-on-error`) | Findings are visible but do not block merge |
+
+A green CI run does **not** guarantee zero checkpatch/cppcheck/sparse findings.
+Always read tool output directly for kernel-file regressions.
diff --git a/docs/TECHNICAL.md b/docs/TECHNICAL.md
index 553ecd7..275e8ab 100644
--- a/docs/TECHNICAL.md
+++ b/docs/TECHNICAL.md
@@ -162,6 +162,13 @@ Notes:
 ```
 Non-interactive mode - write PID once and print both process and thread information.
 
+Other supported invocations:
+
+```bash
+./build/proclens --help    # or -h: print usage and exit
+./build/proclens --version # or -v: print version string and exit
+```
+
 ### Environment Override
 
 You can override the proc directory for testing: