[FEATURE] Package a manual page for every native Coreutils applet #5
Labels
No labels
alpha-1
bug
ci
docs
duplicate
enhancement
help wanted
invalid
performance
phase-6
question
refactor
security
wontfix
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set
Reference
erix/coreutils#5
Loading…
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Problem and motivation
The native manual reader currently has pages for man, basename and dirname.
The other authenticated Coreutils commands also need useful offline instructions.
A hardcoded packaging list will drift as applets and pages change.
Proposed behavior and scope
Write original section-1 pages for all 23 current authenticated applets. Cover
implemented syntax and options, examples, exit status, failures and authority.
Do not advertise unsupported GNU options or imply POSIX behavior not implemented.
Define one explicit versioned page manifest that binds section, name, relative
source file and summary to the applet catalog. The store packer and Integration
consume this manifest. Require exact catalog coverage, unique identities, safe
source paths and safe text; preserve the existing manual-store format.
Authority, security and reliability
Manual names and source spellings are build data. Packaging receives explicit
original sources, with no directory search or environment fallback. Reject
missing, duplicate, substituted or unsafe inputs before publishing a store.
The reader still receives one exact READ lease; this adds no runtime authority.
Digests check consistency and do not authenticate an author.
Acceptance criteria
Alternatives and tradeoffs
Keeping separate page lists in Coreutils and Integration would duplicate policy.
An explicit manifest makes omissions visible while keeping the existing single
store and safe plain-text reader. Other CLI, IPC and Rust/C API inventories
remain separate requirements.
Tracking and rollout
Depends on Coreutils #4.
Coordinate Coreutils PR 2,
Integration PR 12 and the
phase completion issue.
All 23 command pages are now adopted by Integration4002c16e through the selected manifest writer and common image-copy path. This completes the issue scope; broader command/API inventories and guest acceptance remain tracked separately.