Skip to content

docs: document --help/--version flags and clarify CI gate enforcement #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
github-actions wants to merge 1 commit into from
Closed

docs: document --help/--version flags and clarify CI gate enforcement #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/CODE_QUALITY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
7 changes: 7 additions & 0 deletions docs/TECHNICAL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading