[FEATURE] Build the manual through explicit owned inputs #18

Open
opened 2026-10-14 11:42:31 +02:00 by erikinkinen · 0 comments
Owner

Problem and motivation

Manual builds need reviewable source, tool and runtime inputs, with fresh products, finite resource allowances and complete diagnostic records.

Proposed behavior and scope

Use one explicit versioned request for the complete manual source cohort, selected renderer procedures and tools, environment, working/build/output directories, original command ownership and finite time, input and output allowances. Retain complete command proposals, streams and original terminals. Bind the final PDF, checksum and nonempty TeX log to that fresh invocation.

Preserve the manual's rendering semantics and final warning gate. Migrate the documented and CI callers together, remove superseded shell/environment selectors, and keep the implementation in focused modules.

Authority, security and reliability

The enclosing caller owns source, runtime, filesystem and tool lifetimes. A request describes those selected host inputs; names and hashes do not establish native EriX or guest admission. Use the original command owner's cancellation, waits and cleanup, preserve the first failure and independent retirement errors, and reject incomplete or uncertain results. A prior product cannot substitute for this invocation's product.

Acceptance criteria

  • Implement the complete request, bounded renderer ownership and coherent caller migration.
  • Retain full diagnostics and bind fresh final products to the selected inputs.
  • Cover missing or changed inputs/tools, warnings, budgets, cancellation, cleanup and prior-product substitution.
  • Render the complete manual with the changed procedure and retain its final warning-free result.
  • Document the contract, keep authored modules below 1,000 lines and publish the reviewed change.

Alternatives and tradeoffs

An explicit request keeps source selection and resource policy together. Separate input, execution and product handling makes the original ownership and failure paths easier to review. Installed host runtime assumptions remain visible rather than being inferred from an executable fingerprint.

Tracking and rollout

Documentation audit, API conversion, artifact publication, manual review, CI compatibility, phase completion.

Coordinate the builder and publisher callers without changing either operation's ownership. Keep detailed private authority findings separate from this interface design.

## Problem and motivation Manual builds need reviewable source, tool and runtime inputs, with fresh products, finite resource allowances and complete diagnostic records. ## Proposed behavior and scope Use one explicit versioned request for the complete manual source cohort, selected renderer procedures and tools, environment, working/build/output directories, original command ownership and finite time, input and output allowances. Retain complete command proposals, streams and original terminals. Bind the final PDF, checksum and nonempty TeX log to that fresh invocation. Preserve the manual's rendering semantics and final warning gate. Migrate the documented and CI callers together, remove superseded shell/environment selectors, and keep the implementation in focused modules. ## Authority, security and reliability The enclosing caller owns source, runtime, filesystem and tool lifetimes. A request describes those selected host inputs; names and hashes do not establish native EriX or guest admission. Use the original command owner's cancellation, waits and cleanup, preserve the first failure and independent retirement errors, and reject incomplete or uncertain results. A prior product cannot substitute for this invocation's product. ## Acceptance criteria - [ ] Implement the complete request, bounded renderer ownership and coherent caller migration. - [ ] Retain full diagnostics and bind fresh final products to the selected inputs. - [ ] Cover missing or changed inputs/tools, warnings, budgets, cancellation, cleanup and prior-product substitution. - [ ] Render the complete manual with the changed procedure and retain its final warning-free result. - [ ] Document the contract, keep authored modules below 1,000 lines and publish the reviewed change. ## Alternatives and tradeoffs An explicit request keeps source selection and resource policy together. Separate input, execution and product handling makes the original ownership and failure paths easier to review. Installed host runtime assumptions remain visible rather than being inferred from an executable fingerprint. ## Tracking and rollout [Documentation audit](https://git.erikinkinen.fi/erix/docs/issues/2), [API conversion](https://git.erikinkinen.fi/erix/docs/issues/14), [artifact publication](https://git.erikinkinen.fi/erix/docs/issues/16), [manual review](https://git.erikinkinen.fi/erix/docs/pulls/4), [CI compatibility](https://git.erikinkinen.fi/erix/integration/issues/113), [phase completion](https://git.erikinkinen.fi/erix/integration/issues/65). Coordinate the builder and publisher callers without changing either operation's ownership. Keep detailed private authority findings separate from this interface design.
erikinkinen added this to the Alpha 1 milestone 2026-10-30 09:33:40 +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/docs#18
No description provided.