docs: document --help/--version flags and clarify CI gate enforcement - #48
Closed
github-actions[bot] wants to merge 1 commit into
Closed
github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
- 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>
github-actions
Bot
added
automation
documentation
navidpadid
deleted the
docs/fix-cli-flags-and-ci-gate-enforcement-dbf121e1d68153b9
branch
April 2, 2026 07:33
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Two documentation gaps detected against current source code and CI configuration.
Changes
docs/TECHNICAL.md— Argument Mode sectionThe
--help/-hand--version/-vflags were added in the versioning commit (#39) but were never reflected in the implementation docs. The Argument Mode section previously showed only./build/proclens <PID>.Added the two missing invocations alongside the existing PID example.
docs/CODE_QUALITY.md— Notes on Enforcement sectionThe section noted that some Makefile targets are best-effort (
|| true) but did not distinguish between the hard and soft CI gates. Contributors could incorrectly assume that a green CI run means the code is fully analysis-clean.Added a CI Gate Summary table that maps each quality target to its actual CI behavior:
make format-checkmake checkpatchcontinue-on-error)make cppcheckcontinue-on-error)make sparsecontinue-on-error)Validation
src/proclens.c(print_usage()) and.github/workflows/ci.yml.