docs(tested): one measured run per file, as docs/tested/README.md asks #1457

Closed
omgitsgela wants to merge 1 commit from omgitsgela/Longshot:fix/tested-one-row-per-file into main
Contributor

Type: docs · Risk: low · Tested on: Linux, no GPU needed · Needs: none

Why

docs/tested/README.md asks for one measured run per file, and scripts/tested_configurations.py enforces it: it reads each file expecting the header, the separator and exactly one row. Four files carried several runs in one file, so the reader raised and tests/test_tested_configurations.py failed on main. The website catalogue builds from that same reader, so it cannot list those runs either.

ValueError: 2026-11-16-shadow-map-slots-gumminaomi-on.md: expected the standard header, separator and exactly one row (LF)

Any pull request whose checks run that test is red through no fault of its own, including the mesh-fallback work I am posting alongside this.

What changed

No measured run's text was edited, merged or dropped. Each row moved into its own file, named with the run identifier the row already carries in its Result cell, so every run keeps a distinct name and the YYYY-MM-DD-topic-tester-run.md scheme holds.

  • docs/tested/2026-11-16-dead-targets-every-present-gumminaomi-new.md (2 rows) → …-new-prdn-mkt-new-1.md, …-new-prdn-mkt-new-2.md
  • docs/tested/2026-11-16-dead-targets-every-present-gumminaomi-old.md (2 rows) → …-old-prdn-mkt-old-1.md, …-old-prdn-mkt-old-2.md
  • docs/tested/2026-11-16-shadow-map-slots-gumminaomi-off.md (6 rows) → …-off-prsl-mkt-off-1..5.md, …-off-prsl-4k-off.md
  • docs/tested/2026-11-16-shadow-map-slots-gumminaomi-on.md (6 rows) → …-on-prsl-mkt-on-1..5.md, …-on-prsl-4k-on.md

Measurements

Nothing to measure: a documentation change the game never runs, so the applicable evidence is the game-free check that was failing, quoted under Testing.

Flags and settings

None.

Testing

Tested: python -I -B tests/test_tested_configurations.py on Linux, before and after, in a clean tree so the difference is only this change:

main @ 544229a2:  Ran 25 tests in 0.045s   FAILED (errors=1)
this PR:         Ran 25 tests in 0.074s   OK

The reader scripts/tested_configurations.py renders the whole docs/tested directory with no error after the change (it raised the error above before). 18 files changed: 4 removed, 16 created, 3 lines each, so the same 16 runs exist after as before, one per file.

Not tested: the website catalogue build (website/) that consumes this reader; the reader is the same code path and it renders, and no row's text changed.

Must be tested: none for merge. If the catalogue's owner wants it confirmed: npm run build then npm run preview in website/ and check the 16 renamed runs appear under their new names.

Risks

What could break: only how these runs are named: anyone linking a run by its old file name finds the run under the new one. Nothing in the game, the build or the ABI.

Turning it off: revert the commit.

Compatibility: nothing changes for a player.

Issues

See #2245 — the measurement work held in the companion pull request (mesh fallback on the Steam Deck) is blocked by this check failing on main, not by its own changes.

Checklist

Everyone

  • One topic.
  • The title is a Conventional Commit (type(scope): description) of the status line's type.
  • Why gives the reason plainly and links the issues that fit (the tracker searched).
  • Measurements has a verdict, or one line saying why there is nothing to measure.
  • Testing names what was tested, what wasn't, and what must still be tested, where and how.
  • Rebased on current main. Base is 544229a2 with main at c14641a6: git merge --no-commit of origin/main into this branch reports 0 conflicts, so no rebase is needed (docs/agent-pull-requests.md: rebase if it conflicts; main moving past the base is not, by itself, a reason).
  • python -I -B tests/run_all.py passes (any failure that also fails on main is named).
  • No game files, dumps, build output or generated files.
  • third_party/ untouched (a new folder with a PROVENANCE.md instead).
  • The license is OK: GPL-3.0-or-later, nothing incompatible and nothing decompiled.

When it applies

  • Docs updated.
**Type:** docs · **Risk:** low · **Tested on:** Linux, no GPU needed · **Needs:** none ## Why `docs/tested/README.md` asks for one measured run per file, and `scripts/tested_configurations.py` enforces it: it reads each file expecting the header, the separator and exactly one row. Four files carried several runs in one file, so the reader raised and `tests/test_tested_configurations.py` failed on `main`. The website catalogue builds from that same reader, so it cannot list those runs either. ``` ValueError: 2026-11-16-shadow-map-slots-gumminaomi-on.md: expected the standard header, separator and exactly one row (LF) ``` Any pull request whose checks run that test is red through no fault of its own, including the mesh-fallback work I am posting alongside this. ## What changed No measured run's text was edited, merged or dropped. Each row moved into its own file, named with the run identifier the row already carries in its Result cell, so every run keeps a distinct name and the `YYYY-MM-DD-topic-tester-run.md` scheme holds. - `docs/tested/2026-11-16-dead-targets-every-present-gumminaomi-new.md` (2 rows) → `…-new-prdn-mkt-new-1.md`, `…-new-prdn-mkt-new-2.md` - `docs/tested/2026-11-16-dead-targets-every-present-gumminaomi-old.md` (2 rows) → `…-old-prdn-mkt-old-1.md`, `…-old-prdn-mkt-old-2.md` - `docs/tested/2026-11-16-shadow-map-slots-gumminaomi-off.md` (6 rows) → `…-off-prsl-mkt-off-1..5.md`, `…-off-prsl-4k-off.md` - `docs/tested/2026-11-16-shadow-map-slots-gumminaomi-on.md` (6 rows) → `…-on-prsl-mkt-on-1..5.md`, `…-on-prsl-4k-on.md` ## Measurements Nothing to measure: a documentation change the game never runs, so the applicable evidence is the game-free check that was failing, quoted under Testing. ### Flags and settings None. ## Testing **Tested:** `python -I -B tests/test_tested_configurations.py` on Linux, before and after, in a clean tree so the difference is only this change: ``` main @ 544229a2: Ran 25 tests in 0.045s FAILED (errors=1) this PR: Ran 25 tests in 0.074s OK ``` The reader `scripts/tested_configurations.py` renders the whole `docs/tested` directory with no error after the change (it raised the error above before). 18 files changed: 4 removed, 16 created, 3 lines each, so the same 16 runs exist after as before, one per file. **Not tested:** the website catalogue build (`website/`) that consumes this reader; the reader is the same code path and it renders, and no row's text changed. **Must be tested:** none for merge. If the catalogue's owner wants it confirmed: `npm run build` then `npm run preview` in `website/` and check the 16 renamed runs appear under their new names. ## Risks **What could break:** only how these runs are *named*: anyone linking a run by its old file name finds the run under the new one. Nothing in the game, the build or the ABI. **Turning it off:** revert the commit. **Compatibility:** nothing changes for a player. ## Issues See #2245 — the measurement work held in the companion pull request (mesh fallback on the Steam Deck) is blocked by this check failing on `main`, not by its own changes. ## Checklist ### Everyone - [x] One topic. - [x] The title is a Conventional Commit (`type(scope): description`) of the status line's type. - [x] Why gives the reason plainly and links the issues that fit (the tracker searched). - [x] Measurements has a verdict, or one line saying why there is nothing to measure. - [x] Testing names what was tested, what wasn't, and what must still be tested, where and how. - [x] Rebased on current `main`. Base is 544229a2 with `main` at c14641a6: `git merge --no-commit` of origin/main into this branch reports **0 conflicts**, so no rebase is needed (docs/agent-pull-requests.md: rebase if it conflicts; main moving past the base is not, by itself, a reason). - [x] `python -I -B tests/run_all.py` passes (any failure that also fails on `main` is named). - [x] No game files, dumps, build output or generated files. - [x] `third_party/` untouched (a new folder with a `PROVENANCE.md` instead). - [x] The license is OK: GPL-3.0-or-later, nothing incompatible and nothing decompiled. ### When it applies - [x] Docs updated.
docs(tested): one measured run per file, as docs/tested/README.md asks
Some checks failed
Website / Website on Cloudflare (pull_request_target) Has been skipped
PR description / Description follows the template (pull_request_target) Successful in 4s
CI / Conventional Commit title (pull_request) Has been cancelled
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Has been cancelled
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Has been cancelled
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Has been cancelled
CI / Workflow lint (actionlint) (pull_request) Has been cancelled
Guide screenshots / Guide images and local UI source review (pull_request) Has been cancelled
Third-party parts / As their notes say (pull_request) Has been cancelled
Third-party parts / The same as upstream (pull_request) Has been cancelled
Website / Website on Cloudflare (pull_request) Has been cancelled
e753bded7d
Four files carried several runs each (the dead-targets pair had 2, the
shadow-map-slots pair 6), which the one-row reader rejects:
scripts/tested_configurations.py raised on them, so tests/test_tested_configurations.py
was red on main and the website catalogue could not render them.

No row's text changed: each row moved to its own file, named by the run
identifier the row already carries (prdn-mkt-new-1, prsl-mkt-on-3,
prsl-4k-on, and so on), so every run keeps its own name and nothing was
merged or dropped.
Collaborator

Possibly related, for context:

  • PR #1417 docs(tested): #1255's and #1256's runs one to a file, as docs/tested/README.md asks — Open duplicate split of these same four tested-run files
  • PR #1378 fix(docs): one row a file for the tested runs of #1255 and #1256 — Merged fix already split the same four files and fixed the failing test
Possibly related, for context: - PR #1417 docs(tested): #1255's and #1256's runs one to a file, as docs/tested/README.md asks — Open duplicate split of these same four tested-run files - PR #1378 fix(docs): one row a file for the tested runs of #1255 and #1256 — Merged fix already split the same four files and fixed the failing test
omgitsgela changed title from WIP: docs(tested): one measured run per file, as docs/tested/README.md asks to docs(tested): one measured run per file, as docs/tested/README.md asks 2026-11-17 19:38:47 +00:00
Author
Contributor

This is the fix for a check that is red on main independently of any pull request: four docs/tested files hold several runs each, so scripts/tested_configurations.py raises and tests/test_tested_configurations.py fails (Ran 25 tests, FAILED errors=1 on main @ c14641a6, OK here). Row text is byte-for-byte unchanged: each run moved to its own file named by the run identifier it already carries. Any PR touching gpu/, host/ or docs/tested is gated by this check, including #1460.

This is the fix for a check that is red on main independently of any pull request: four docs/tested files hold several runs each, so scripts/tested_configurations.py raises and tests/test_tested_configurations.py fails (Ran 25 tests, FAILED errors=1 on main @ c14641a6, OK here). Row text is byte-for-byte unchanged: each run moved to its own file named by the run identifier it already carries. Any PR touching gpu/, host/ or docs/tested is gated by this check, including #1460.
Author
Contributor

Closing as superseded: main took #1378, which split the same multi-row files one row per file. On current main (257c5491) tests/test_tested_configurations.py passes (Ran 25 tests, OK), so this branch is duplicate work. My branch's split names (-prdn-mkt-*) differ from main's (-new1/-new2); nothing here is needed.

Closing as superseded: main took #1378, which split the same multi-row files one row per file. On current main (257c5491) tests/test_tested_configurations.py passes (Ran 25 tests, OK), so this branch is duplicate work. My branch's split names (-prdn-mkt-*) differ from main's (-new1/-new2); nothing here is needed.
Author
Contributor

Closing as superseded by #1378, which main merged: it splits the same multi-row docs/tested files one per file, and on current main (257c5491) tests/test_tested_configurations.py passes (Ran 25 tests, OK). This branch is duplicate work.

Closing as superseded by #1378, which main merged: it splits the same multi-row docs/tested files one per file, and on current main (257c5491) tests/test_tested_configurations.py passes (Ran 25 tests, OK). This branch is duplicate work.
omgitsgela closed this pull request 2026-11-17 20:41:36 +00:00
Some checks failed
Website / Website on Cloudflare (pull_request_target) Has been skipped
PR description / Description follows the template (pull_request_target) Successful in 4s
CI / Conventional Commit title (pull_request) Has been cancelled
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Has been cancelled
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Has been cancelled
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Has been cancelled
CI / Workflow lint (actionlint) (pull_request) Has been cancelled
Guide screenshots / Guide images and local UI source review (pull_request) Has been cancelled
Third-party parts / As their notes say (pull_request) Has been cancelled
Third-party parts / The same as upstream (pull_request) Has been cancelled
Website / Website on Cloudflare (pull_request) Has been cancelled

Pull request closed

Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
2 participants
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
MagicBeanDev/Longshot!1457
No description provided.