[FEATURE] Add indexed Exsh and builtin manual pages #26
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/exsh#26
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
Internal help documents the shell's authoritative topics, but offline man cannot
yet resolve Exsh or its builtins. Pages should follow the implemented behavior
and stay in sync with that same registry.
Proposed behavior and scope
Add original exsh(1) documentation and a useful indexed page for each of the 33
current registry topics in section
1exsh. Literal builtin names remain the indexnames, including punctuation. For example, man -s 1exsh true selects the builtin;
man -s 1 true selects the external Coreutils command.
Maintain an explicit component manifest. Bind page coverage and descriptive
fields to the authoritative registry with a closed, nonexecuting freshness check.
Compose explicitly selected component manifests into the same existing store,
rejecting duplicate(name,section) identities across components. Keep source
selection explicit and migrate maintained consumers before removing the old
individual-page packaging interface.
Authority, security and reliability
The reader keeps its existing exact read-only store lease. Packaging must not
search environment paths, enumerate directories for missing manuals or execute
page text. Open each selected component's descendants without following aliases,
encode retained validated snapshots and preserve original read/cleanup failures.
A source hash checks consistency with the selected component; it grants no access
and does not authenticate a publisher.
Acceptance criteria
1exsh) names.Alternatives and tradeoffs
Namespacing the builtin section preserves literal names without merging shell and
external-command behavior. Linking every topic to one generic page would make
lookup easy but provide weaker command-specific documentation.
Tracking and rollout
Extends shell help and
Coreutils manuals.
Coordinate Exsh PR3,
Coreutils PR2 and
Integration PR12.
The shell manual and all 33 builtin/language-topic pages are published in 957772cb. The explicit manifest binds the help and invocation sources; section
1exshkeeps builtin names distinct from external commands. The pages state the current dot, exec, wait and trap limits. Per-topic examples and image adoption remain open.Integration
6abd74c7adopts the complete Exsh inventory in the composed image store. Every topic has a concrete example, and builtin names remain distinct from external commands through section selection. All criteria in this issue are complete.