[FEATURE] Package a manual page for every native Coreutils applet #5

Closed
opened 2026-10-24 00:59:54 +02:00 by erikinkinen · 1 comment
Owner

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

  • Write useful original pages for every current Coreutils applet.
  • Define one explicit manifest with exact authenticated-catalog coverage.
  • Make the store packer consume and validate that manifest.
  • Adopt the same manifest in Integration packaging and update documentation.
  • Cover missing/extra pages, malformed identities, unsafe paths/text and store completeness.

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.

## 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 - [x] Write useful original pages for every current Coreutils applet. - [x] Define one explicit manifest with exact authenticated-catalog coverage. - [x] Make the store packer consume and validate that manifest. - [x] Adopt the same manifest in Integration packaging and update documentation. - [x] Cover missing/extra pages, malformed identities, unsafe paths/text and store completeness. ## 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](https://git.erikinkinen.fi/erix/coreutils/issues/4). Coordinate [Coreutils PR 2](https://git.erikinkinen.fi/erix/coreutils/pulls/2), [Integration PR 12](https://git.erikinkinen.fi/erix/integration/pulls/12) and the [phase completion issue](https://git.erikinkinen.fi/erix/integration/issues/65).
Author
Owner

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.

All 23 command pages are now adopted by [Integration4002c16e](https://git.erikinkinen.fi/erix/integration/commit/4002c16e3bab3117c841fe49a43c78f1887b3d46) 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.
erikinkinen added this to the Alpha 1 milestone 2026-10-30 09:33:35 +01:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
erix/coreutils#5
No description provided.