docs: reconcile the docs with the externally contributed v0.11/v0.12 work#243
Merged
Conversation
…work An audit of the documentation against the source for everything merged since v0.10.0, focused on the contributed features that landed without their documentation half: the filesys services board, the Z3660 RTG card, the A3000/A4000 machines with Gary/Ramsey, and the serial and parallel port work. Stale statements fixed: - peripherals.md still described the filesys handler forwarding DosPackets through a reserved A-line trap; that became MMIO doorbell registers when the services board switched protocols. - chipset.md attributed the Centronics data/strobe to CIA-B, the exact wiring the parallel-port rework corrected: data, /STROBE, and /ACK are CIA-A, only BUSY/POUT/SEL sit on CIA-B port A. - cpu.md reported 68040 write faults in writeback slot 2; the frame builder stacks them in slot 3 (WB2 is reserved for MOVE16), matching real silicon and the MuGuardianAngel/Enforcer protocols. - AGENTS.md promised a positional disk-image argument that main.rs does not implement (the one positional is the ROM); the example now routes the disk through --insert-disk-after, verified to boot. - README/--help called the default machine OCS (the A500 Rev 6A default is ECS Agnus + OCS Denise) and described built-in-defaults startup where a bare invocation opens the launcher; --help also omitted the A1000/A500OCS/A3000/A4000 models and the 68010. - configuration.md and README pointed at a "Serial" launcher tab that was merged into "I/O Ports"; guest/services/README.md described the fixed -128 boot priority (now the mount's bootpri) and a handler started on first reference (it is ADNF_STARTPROC, at mount time). Missing documentation added: - The Z3660 RTG board: a zorro.md section (autoconfig identity, window layout), an internals/video.md "RTG scanout" section (native GPU present, chipset fallback, sprite compositing, screenshot downscale), the launcher's RTG card row in ui.md, the RTG behaviour of capture.screenshot in control.md, and a README feature mention. - peripherals.md sections for Fat Gary and Ramsey (register mirrors, COLDBOOT detection, the version-register identity and control-bit-4 disagreement) and for the parallel-port peripheral boundary (printer capture, the emulated-time sampler). - The services-board per-unit register protocol and the DiagPoint rom_scsi_device_disable cull in peripherals.md, plus the board as product 5 in the manufacturer-ID table. - Smaller gaps: the tcp-connect serial mode in peripherals.md and README, COPPERLINE_DIAG_A4091 in the debugger table, identify in the example config, drag-and-drop cross-referenced from getting-started, the status-bar hide shortcut noted in its section, and the Host Mounts four-of-eight launcher limit.
Contributor
There was a problem hiding this comment.
Pull request overview
Documentation reconciliation pass to bring Copperline’s user/developer docs (and a small amount of user-facing help text/doc-comments) back in sync with features merged since v0.10.0—especially externally contributed work around HostFS/services board, Z3660 RTG, big-box machines, and serial/parallel I/O.
Changes:
- Updated CLI
--help, README, example config, and internal docs to reflect current defaults (A500 Rev 6A ECS Agnus + OCS Denise), supported models/CPUs, and current launcher/UI structure. - Added/expanded documentation for Z3660 RTG (Zorro identity/window layout + scanout/presentation behavior) and big-box peripherals (Fat Gary/Ramsey, parallel port boundary, serial
tcp-connect). - Corrected stale internals docs to match current implementations (services board MMIO doorbells, CIA wiring for Centronics, 68040 writeback slot behavior, handler start semantics/boot priority behavior).
Reviewed changes
Copilot reviewed 17 out of 17 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
src/z3660.rs |
Updates module-level doc comment to reflect implemented RTG board behavior. |
src/main.rs |
Refreshes --help text for supported models/CPUs and the built-in default chipset. |
src/config.rs |
Updates config-field docstring to list all supported serial modes. |
README.md |
Aligns feature list, default startup behavior, and launcher tab naming with current code. |
guest/services/README.md |
Corrects services board boot priority and handler start timing description. |
docs/zorro.md |
Adds Z3660 RTG Zorro III board documentation and services-board manufacturer/product table entry. |
docs/internals/video.md |
Documents RTG scanout/presentation behavior and screenshot downsampling under RTG. |
docs/internals/peripherals.md |
Adds Fat Gary/Ramsey and parallel peripheral boundary documentation; updates filesys and serial docs to MMIO/tcp-connect reality. |
docs/internals/cpu.md |
Corrects 68040 writeback-slot documentation to slot 3. |
docs/internals/chipset.md |
Fixes CIA-A/CIA-B Centronics wiring description. |
docs/guide/ui.md |
Updates launcher/UI documentation (status bar hide shortcut, RTG mention, host-mount limit notes, validation messaging). |
docs/guide/getting-started.md |
Adds drag-and-drop disk insertion cross-reference. |
docs/guide/configuration.md |
Updates launcher tab naming and serial section wording for I/O Ports tab. |
docs/debugger/headless.md |
Adds COPPERLINE_DIAG_A4091 to the env-var table. |
docs/debugger/control.md |
Clarifies screenshot behavior when an RTG screen is active. |
copperline.example.toml |
Adds identify-board note and clarifies RTG default-fit criteria. |
AGENTS.md |
Fixes positional-argument documentation (ROM-only positional; disks via config/flags). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
An audit of the documentation against the source for everything merged since v0.10.0, focused on the contributed features that landed without their documentation half: the filesys services board (#159-#211), the Z3660 RTG card (#212), the A3000/A4000 machines (#180/#184/#185), and the serial/parallel port work (#138/#147/#221). Each finding was verified against the current code before fixing.
Stale documentation fixed
REG_DOSPKThandled synchronously inside the write)./STROBE, and/ACKare CIA-A; only BUSY/POUT/SEL sit on CIA-B port A.main.rsdoes not implement (the single positional is the ROM; a second errors). The example now routes the disk through--insert-disk-after, verified to boot AmigaTestKit on both AROS and KS3.1/A1200.--helpcalled the default machine OCS (the A500 Rev 6A default is ECS Agnus + OCS Denise) and described built-in-defaults startup where a bare invocation opens the launcher;--helpalso omitted the A1000/A500OCS/A3000/A4000 models and the 68010.bootpri) and a handler started on first reference (it isADNF_STARTPROC, at mount time).Missing documentation added
capture.screenshotin control.md, and a README feature mention.rom_scsi_device_disablecull in peripherals.md, plus the board as product 5 in the manufacturer-ID table.tcp-connectserial mode in peripherals.md and README,COPPERLINE_DIAG_A4091in the debugger env-var table,identifyin the example config, drag-and-drop cross-referenced from getting-started, the status-bar hide shortcut noted in its own section, and the Host Mounts four-of-eight launcher limit.Verified clean
The user-facing config surface needed no fixes: every TOML key in
config.rsis documented with correct defaults and accepted values, the[a4091]->[scsi]break left no stale references, and the ui.md shortcut table matcheshost_input.rs1:1.Verification: full unit suite (1773 passed),
cargo clippyandcargo fmt --checkclean,myst build --htmlwith no new warnings. Source changes are help-text and doc-comments only (main.rs,config.rs,z3660.rs).