base-layer/commandkit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

Document flag declaration rules

Browse Source
This commit is contained in:
Eric Rakestraw
2026-11-07 15:47:54 +00:00
parent 52f1d99994
commit 3b75ae7d2e
4 changed files with 21 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/roadmap/audit/catalog.md
View File

@@ -1,6 +1,6 @@
# Consolidated audit catalog
Status: **16 distinct open findings: 16 P3**, consolidated from 30
Status: **15 distinct open findings: 15 P3**, consolidated from 30
numbered entries in seven audit documents. Reviewed audit state:
`db732e3a1de55c844f77870e1c6db683c2685d5d`.
@@ -207,6 +207,10 @@ unused explanation-writer requirement in F11.
## F10 — P3: Public flag metadata omits enforced naming and reserved-spelling rules
**Complete.** FlagMeta documents the existing declaration rules and related
rename and alias GoDoc refers to them. The prose was checked against the
installation validator; no runtime rule changed.
`FlagMeta` describes names without leading dashes and an optional short
spelling, while installation enforces additional name grammar and reserved
spellings. Consumers must discover those constraints through errors or private
@@ -223,8 +227,7 @@ Document the rules once with `FlagMeta` and link related public helpers. This
remediation changes documentation, not runtime validation.
The [F10 analysis](remediation-analysis.md#f10--flag-declaration-naming) reviews
the naming convention's basis and records the accepted direction. Implementation
of the documentation correction remains pending.
the naming convention's basis and records the accepted direction.
**Original:** [13-documentation D2](13-documentation.md#d2--p3-public-flag-metadata-omits-enforced-declaration-constraints).

7
docs/roadmap/implementation.md
View File

@@ -1,6 +1,6 @@
# Audit remediation implementation plan
Status: in progress; Stages 1–9 complete.
Status: in progress; Stages 1–10 complete.
Baseline: `d492c7747175c01a53261206c2b4356e53453621`. Before this sprint,
intervening changes recorded decisions and retired the completed older
@@ -357,6 +357,11 @@ F09, and acquisition-only provider wiring with preserved rendering for F11.
## Stage 10 — Document the selected flag declaration contract
**Complete.** FlagMeta describes the existing Unicode long-name grammar,
reserved names and short spellings; rename and alias guidance links to it.
Reviewed against `validateBindings`, `validFlagName`, and the accepted catalog
decision. No runtime validation was changed.
Findings: F10. Source: `command.go` FlagMeta and related rename/alias GoDoc.
1. Define long names once with FlagMeta: nonempty Unicode lowercase-letter or