Skip to content

docs(status): record the RSP-category Phase 2 criterion as met - #45

Merged
doublegate merged 3 commits into
mainfrom
docs/status-rsp-category-met
Jul 22, 2026
Merged

docs(status): record the RSP-category Phase 2 criterion as met#45
doublegate merged 3 commits into
mainfrom
docs/status-rsp-category-met

Conversation

@doublegate

Copy link
Copy Markdown
Owner

Motivation

docs/STATUS.md is the single source of truth, and it fell out of date after
the RSP work in #41#44. It still listed the RSP vector unit as a stub ("COP2
retires inertly") and reported 250 suite-wide failures (now 93).

Changes (docs-only)

  • Both n64-systemtest readiness tables now carry the RSP-category criterion as
    MET
    — 0 RSP-prefixed failures, down from ~413 at Phase 1 close.
  • The RSP vector unit (full VU ISA, load/store, reserved opcodes) and the DPC
    command registers are marked implemented.
  • BREAK semantics note updated (halts in a taken branch's delay slot).
  • An explicit Phase 2 status: one of two exit criteria met; v0.3.0 is not
    cut until the microcode / RDP-command-list criterion also holds.
  • Suite-wide count corrected 250 → 93 with the current category breakdown.

Verification

The MET claims are the committed #[ignore]d n64-systemtest runner, not a
self-assessment. RSP-category zero was confirmed by dumping every remaining
failure and checking none are RSP-prefixed.

markdownlint green.

🤖 Generated with Claude Code

Updates the single source of truth after #41#44. The RSP vector unit was still
listed as a stub ("COP2 retires inertly") and the suite-wide failure count was
stale (250 -> 93).

- Both n64-systemtest readiness tables now carry the RSP-category criterion as
  MET (0 RSP-prefixed failures, down from ~413 at Phase 1 close).
- The RSP vector unit and the DPC command registers are marked implemented.
- Adds an explicit Phase 2 status: one of two exit criteria met; v0.3.0 is not
  cut until the microcode/RDP-command-list criterion also holds.

Docs-only. markdownlint green.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@gemini-code-assist

Copy link
Copy Markdown

Caution

The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased.

@coderabbitai

coderabbitai Bot commented Jul 22, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 60c51091-4fa6-42ef-8c7c-838f66404ace

📥 Commits

Reviewing files that changed from the base of the PR and between 177ffff and df6680e.

📒 Files selected for processing (1)
  • docs/STATUS.md

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Updated project status: Phase 1 marked complete; Phase 2 RSP exit criterion confirmed met with 0 RSP-prefixed failures.
    • Refreshed n64-systemtest accuracy-gate results, including updated CPU/COP0/TLB/COP1 and Phase 2 RSP figures.
    • Revised test-ROM gate execution details to reflect three gates producing real results today; updated roadmap (RSP vector unit implemented, RDP DPC command registers implemented; RDP rasteriser still stubbed).

Walkthrough

Updates docs/STATUS.md with completed Phase 1 and RSP Phase 2 criteria, implemented RSP/DPC roadmap entries, three active test gates, and revised n64-systemtest accuracy results.

Changes

Status documentation

Layer / File(s) Summary
Milestones and implementation roadmap
docs/STATUS.md
Phase 1 and the RSP Phase 2 criterion are marked complete; RSP vector-unit and DPC register entries are marked implemented, while RDP rasterisation remains stubbed.
Test corpus and accuracy gates
docs/STATUS.md
Three gates now report real results, and the n64-systemtest tables record zero failures for CPU/COP0/TLB/COP1 and RSP-prefixed tests.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 9 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Changelog Entry For User-Visible Changes ⚠️ Warning FAIL: this user-visible docs update has no corresponding [Unreleased] entry in CHANGELOG.md. Add an [Unreleased] changelog bullet for the STATUS.md changes (RSP MET, Phase 2 update, count corrections).
✅ Passed checks (9 passed)
Check name Status Explanation
Title check ✅ Passed Uses Conventional Commits form, stays under 72 characters, and matches the docs-only status update.
Description check ✅ Passed The description aligns with the STATUS.md documentation updates and the RSP Phase 2 criterion change.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Oracle Number Is Stated ✅ Passed PASS: docs/STATUS.md states the current oracle figure (0 RSP-prefixed failures, suite-wide 93), and the PR is docs-only, which this check exempts.
Docs-As-Spec Sync ✅ Passed Only docs/STATUS.md changed; no chip-crate source files are in the diff, and the PR body says the change is docs-only.
Measured, Never Tuned ✅ Passed The only new numerals are failure counts (413→93); no new hardware constant or timing value was added, and existing clocks are already ADR/ledger-anchored.
Unsafe Stays Out Of The Chip Crates ✅ Passed PR diff touches only docs/STATUS.md; all chip crates and rustyn64-core still have #![forbid(unsafe_code)], and no unsafe blocks/fns/impls were found in Rust code.

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/STATUS.md`:
- Around line 114-116: Update the three status rows in the documentation table
to include provenance for each hardware-behavior claim: cite authoritative
manual sections or accuracy-ledger entries and name regression tests covering
BREAK delay-slot behavior, reserved VU operations, and DPC START_VALID
double-latching/FREEZE semantics. Ensure undocumented behavior has both a cited
source and a test that fails if the behavior changes.
- Around line 13-28: Update the stale “not executable” status claims in
docs/STATUS.md, especially the statements around the n64-systemtest count and
runner output, to reflect the now-available real gate results shown in the
current status section. Remove or revise the conflicting Sprint 2 and “never
reports a real number” wording so the document consistently presents Phase 1 as
complete and treats docs/STATUS.md as the authoritative source.
- Around line 13-14: Add the RSP test started/completed count to the Phase 2 RSP
status entry at docs/STATUS.md lines 13-14, alongside the existing zero-failure
evidence. Apply the same count update to the corresponding RSP entry at
docs/STATUS.md lines 195-196, preserving the existing phase status and test
command.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: d9813086-af98-4dc1-97b5-2813ebef7cd7

📥 Commits

Reviewing files that changed from the base of the PR and between b13dd53 and 376dfe3.

📒 Files selected for processing (1)
  • docs/STATUS.md

Comment thread docs/STATUS.md Outdated
Comment thread docs/STATUS.md
Comment thread docs/STATUS.md Outdated
Adopts the three CodeRabbit comments on PR #45.

- Removes the stale "n64-systemtest cannot report a count until Sprint 2 / the
  golden-log source returns an empty Vec / the second is never true" claims,
  which contradicted the MET rows. STATUS.md now states that basic.z64,
  n64-systemtest, and the golden log are all wired, executable gates reporting
  real numbers; only the visual goldens and accuracy battery remain staged.
- Adds "across 917 tests started" to both RSP-category rows so the criterion is
  execution-backed, not failure-only.
- Adds spec/provenance/regression pointers to the RSP-scalar, RSP-vector, and
  DPC feature-matrix rows (docs/rsp.md, docs/rdp.md, the N64brew Interface page,
  and the named test modules).

Docs-only. markdownlint green.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/STATUS.md`:
- Line 14: Update the n64-systemtest status entry to remove the ambiguous “was
~413 at Phase 1 close” parenthetical or explicitly qualify ~413 as the
suite-wide failure count. Preserve the existing RSP category result and use
docs/STATUS.md as the authoritative wording for historical counts.
- Around line 99-106: Update the opening sentence in the status section to say
“Three gates execute real results today,” distinguishing executable gates from
corpus entries while preserving the existing details about basic.z64,
n64-systemtest, and golden-log.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: d529a565-d1e8-46c4-95be-9d9f3015085a

📥 Commits

Reviewing files that changed from the base of the PR and between 376dfe3 and 177ffff.

📒 Files selected for processing (1)
  • docs/STATUS.md

Comment thread docs/STATUS.md Outdated
Comment thread docs/STATUS.md Outdated
…ates

Adopts CodeRabbit's two follow-up nits on PR #45.

- The RSP-category row no longer implies 413 was an RSP-category count: 413 was
  the suite-wide total (of which RSP was the bulk), now 93.
- "Three of these are executed by a gate" -> "Three gates execute real results
  today": the golden log is a gate, not a corpus entry, so the previous wording
  mixed the two terminologies.

Docs-only. markdownlint green.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant