MagicBeanDev/Longshot

Watch

Fork 98

docs(profiles): the renderer profile's note has its Recorded line again #625

Open

zeldaootr wants to merge 1 commit from zeldaootr/Longshot:profile-note-recorded-line into main

zeldaootr commented

2026-11-15 00:55:57 +00:00

Contributor

Type: docs · Risk: low · Tested on: Linux, no GPU (game-free check) · Needs: none

Why

tests/test_vk_pgo.py has failed on main since the profile's note was rewritten for the merged recordings (#599), so main is red before a release candidate. The note still says where each recording was made, but lost the Recorded: line the check asks for, and which scripts/pipeline_tour.py merge-profile --publish writes its own note to replace ("in place of the Recorded, GPU and driver, and Compiler lines"). So the note is what changed shape, not the check. No open pull request or claim covers it.

How to reproduce

Seen on: Linux (Ubuntu 24.04), no GPU
Settings and switches: none
Steps: on main aa95d35f, run python -I -B tests/test_vk_pgo.py
Expected: OK: the renderer's play profile is opt-in, and the game's counters keep their own switch
Actual: FAIL: its note says where it was recorded

What changed

One word in assets/profiles/README.md: the paragraph that introduces the three recordings starts with Recorded: again. Nothing else in the note, the profile or the code changes.

assets: assets/profiles/README.md: "Three recordings of an RX_VK_PGO=gen renderer, merged ..." reads "Recorded: three sessions of an RX_VK_PGO=gen renderer, merged ...".

Measurements

Verdict: passes: the check fails on main and passes on this branch in two interleaved rounds.

Hardware: Linux (Ubuntu 24.04, kernel 6.8), x86-64, no GPU used; Python 3.15
Scene: no game: the game-free check
Method: the check run alone, round 1 on main then this branch, round 2 the same again
How to reproduce: python -I -B tests/test_vk_pgo.py on each commit

	Before: main @ `aa95d35f`	After: this PR @ `ac5da416`
Check result, round 1 / round 2	fail / fail	pass / pass

main@aa95d35f r1 test_vk_pgo.py none rc=1 | FAIL: its note says where it was recorded
main@aa95d35f r2 test_vk_pgo.py none rc=1 | FAIL: its note says where it was recorded
profile-note-recorded-line@ac5da416 r1 test_vk_pgo.py none rc=0 | OK: the renderer's play profile is opt-in, and the game's counters keep their own switch
profile-note-recorded-line@ac5da416 r2 test_vk_pgo.py none rc=0 | OK: the renderer's play profile is opt-in, and the game's counters keep their own switch

Flags and settings

None

Testing

Tested: on Linux, the check failing on main aa95d35f and passing here in two interleaved rounds (before this rebase, the same on main 6c9edffe at 587b985f); it passes at 25726217, and the note's only change since is e9bed614 (#599's merge), which is what turned it red. The full suite (python -I -B tests/run_all.py, Linux, LONGSHOT_VULKAN_HEADERS set) on main 6c9edffe with this and the six other red-check repairs from the same sweep merged locally (1ba90202, not pushed): 525 passed, 4 failed, 51 skipped. Three of the failures fail on main too and have their own pull requests: tests/test_walk_key.py (#497), tests/test_cpm_discovery.py (#561), tests/test_make_game_cache.py (#592). The fourth, tests/test_crash_record.py, timed out waiting 10 s for a signalled child under load and passes alone, twice. Rebased since onto main aa95d35f, the commit re-authored under the forge's noreply address: its change is identical to before by git patch-id; on aa95d35f the check also ran through the runner with g++ 13.3 and with clang 23.1.5, failing on main and passing here.

Not tested: nothing else reads the note's text.

Must be tested: None

Risks

What could break: nothing: one word of documentation.

Turning it off: revert the commit

Compatibility: Nothing 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. Onto main aa95d35f with no conflict; the change is identical to before by git patch-id.
python -I -B tests/run_all.py passes (any failure that also fails on main is named). The full run is the one in Testing, on main 6c9edffe; after the rebase onto aa95d35f, the changed check through the runner with g++ and clang, as above.
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

AI assistance recorded with Assisted-by: / Co-Authored-By: trailers.
Numbers from the same PC, scene and settings, at least 2 interleaved runs each, the median reported.
Docs updated.

**Type:** docs · **Risk:** low · **Tested on:** Linux, no GPU (game-free check) · **Needs:** none ## Why `tests/test_vk_pgo.py` has failed on `main` since the profile's note was rewritten for the merged recordings (https://git.magicbean.dev/MagicBeanDev/Longshot/pulls/599), so `main` is red before a release candidate. The note still says where each recording was made, but lost the `Recorded:` line the check asks for, and which `scripts/pipeline_tour.py merge-profile --publish` writes its own note to replace ("in place of the Recorded, GPU and driver, and Compiler lines"). So the note is what changed shape, not the check. No open pull request or claim covers it. ## How to reproduce **Seen on:** Linux (Ubuntu 24.04), no GPU **Settings and switches:** none **Steps:** on `main` aa95d35f, run `python -I -B tests/test_vk_pgo.py` **Expected:** `OK: the renderer's play profile is opt-in, and the game's counters keep their own switch` **Actual:** `FAIL: its note says where it was recorded` ## What changed One word in `assets/profiles/README.md`: the paragraph that introduces the three recordings starts with `Recorded:` again. Nothing else in the note, the profile or the code changes. - assets: `assets/profiles/README.md`: "Three recordings of an `RX_VK_PGO=gen` renderer, merged ..." reads "Recorded: three sessions of an `RX_VK_PGO=gen` renderer, merged ...". ## Measurements **Verdict:** passes: the check fails on `main` and passes on this branch in two interleaved rounds. Hardware: Linux (Ubuntu 24.04, kernel 6.8), x86-64, no GPU used; Python 3.15 Scene: no game: the game-free check Method: the check run alone, round 1 on main then this branch, round 2 the same again How to reproduce: `python -I -B tests/test_vk_pgo.py` on each commit | | Before: main @ aa95d35f | After: this PR @ ac5da416 | |---|---|---| | Check result, round 1 / round 2 | fail / fail | pass / pass | ``` main@aa95d35f r1 test_vk_pgo.py none rc=1 | FAIL: its note says where it was recorded main@aa95d35f r2 test_vk_pgo.py none rc=1 | FAIL: its note says where it was recorded profile-note-recorded-line@ac5da416 r1 test_vk_pgo.py none rc=0 | OK: the renderer's play profile is opt-in, and the game's counters keep their own switch profile-note-recorded-line@ac5da416 r2 test_vk_pgo.py none rc=0 | OK: the renderer's play profile is opt-in, and the game's counters keep their own switch ``` ### Flags and settings None ## Testing **Tested:** on Linux, the check failing on main aa95d35f and passing here in two interleaved rounds (before this rebase, the same on main 6c9edffe at 587b985f); it passes at 25726217, and the note's only change since is e9bed614 (#599's merge), which is what turned it red. The full suite (`python -I -B tests/run_all.py`, Linux, `LONGSHOT_VULKAN_HEADERS` set) on main 6c9edffe with this and the six other red-check repairs from the same sweep merged locally (1ba90202, not pushed): 525 passed, 4 failed, 51 skipped. Three of the failures fail on main too and have their own pull requests: `tests/test_walk_key.py` (https://git.magicbean.dev/MagicBeanDev/Longshot/pulls/497), `tests/test_cpm_discovery.py` (https://git.magicbean.dev/MagicBeanDev/Longshot/pulls/561), `tests/test_make_game_cache.py` (https://git.magicbean.dev/MagicBeanDev/Longshot/pulls/592). The fourth, `tests/test_crash_record.py`, timed out waiting 10 s for a signalled child under load and passes alone, twice. Rebased since onto main aa95d35f, the commit re-authored under the forge's noreply address: its change is identical to before by `git patch-id`; on aa95d35f the check also ran through the runner with g++ 13.3 and with clang 23.1.5, failing on main and passing here. **Not tested:** nothing else reads the note's text. **Must be tested:** None ## Risks **What could break:** nothing: one word of documentation. **Turning it off:** revert the commit **Compatibility:** Nothing 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`. Onto main aa95d35f with no conflict; the change is identical to before by `git patch-id`. - [x] `python -I -B tests/run_all.py` passes (any failure that also fails on `main` is named). The full run is the one in Testing, on main 6c9edffe; after the rebase onto aa95d35f, the changed check through the runner with g++ and clang, as above. - [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] AI assistance recorded with `Assisted-by:` / `Co-Authored-By:` trailers. - [x] Numbers from the same PC, scene and settings, at least 2 interleaved runs each, the median reported. - [x] Docs updated.

zeldaootr added 1 commit

2026-11-15 00:55:57 +00:00

the renderer profile's note says Recorded: again

PR description / Description follows the template (pull_request_target) Successful in 4s

Details

Website / Website on Cloudflare (pull_request_target) Has been skipped

Details

CI / Conventional Commit title (pull_request) Has been cancelled

Details

CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Has been cancelled

Details

CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Has been cancelled

Details

CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Has been cancelled

Details

CI / Workflow lint (actionlint) (pull_request) Has been cancelled

Details

Third-party parts / As their notes say (pull_request) Has been cancelled

Details

Third-party parts / The same as upstream (pull_request) Has been cancelled

Details

587b985f2a

Assisted-by: Claude

#599 rewrote the note's provenance as numbered recordings without the `Recorded:` line, which `test_vk_pgo` asks for and `pipeline_tour.py merge-profile --publish` writes its note in place of.

sheep referenced this pull request from a commit

2026-11-15 05:15:02 +00:00

docs(profiles): the renderer profile's note has its Recorded line again

gmourao referenced this pull request

2026-11-15 05:51:24 +00:00

Game: Ganondorf initially renders completely black, then recovers after a long delay on RX 9060 XT #715

mooki added the

labels

2026-11-15 13:56:36 +00:00

zeldaootr force-pushed profile-note-recorded-line from 587b985f2a

PR description / Description follows the template (pull_request_target) Successful in 4s

Details

Website / Website on Cloudflare (pull_request_target) Has been skipped

Details

CI / Conventional Commit title (pull_request) Has been cancelled

Details

CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Has been cancelled

Details

CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Has been cancelled

Details

CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Has been cancelled

Details

CI / Workflow lint (actionlint) (pull_request) Has been cancelled

Details

Third-party parts / As their notes say (pull_request) Has been cancelled

Details

Third-party parts / The same as upstream (pull_request) Has been cancelled

Details

to ac5da416e7

CI / Conventional Commit title (pull_request) Blocked by required conditions

Details

CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Blocked by required conditions

Details

CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Blocked by required conditions

Details

CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Blocked by required conditions

Details

CI / Workflow lint (actionlint) (pull_request) Blocked by required conditions

Details

Guide screenshots / Guide images and local UI source review (pull_request) Blocked by required conditions

Details

Third-party parts / As their notes say (pull_request) Blocked by required conditions

Details

Third-party parts / The same as upstream (pull_request) Blocked by required conditions

Details

Website / Website on Cloudflare (pull_request) Blocked by required conditions

Details

PR description / Description follows the template (pull_request_target) Successful in 3s

Details

2026-11-15 17:12:51 +00:00

Compare

zeldaootr commented

2026-11-15 17:12:54 +00:00

Author

Contributor

Rebased onto main aa95d35f (head ac5da416); the commits are re-authored with the forge's noreply address: no code change, the same patches by git patch-id.
Test re-run: test_vk_pgo fails on main aa95d35f (its note says where it was recorded) and passes here, two interleaved rounds, and through the runner with g++ and clang; the description names the new commit.

Rebased onto `main` aa95d35f (head ac5da416); the commits are re-authored with the forge's noreply address: no code change, the same patches by `git patch-id`. Test re-run: `test_vk_pgo` fails on main aa95d35f (its note says where it was recorded) and passes here, two interleaved rounds, and through the runner with g++ and clang; the description names the new commit.

zeldaootr referenced this pull request

2026-11-15 17:14:59 +00:00

docs(profiles): the play profile's note says Recorded: again, which test_vk_pgo looks for #807