docs(guide): keep the Graphics screenshot after #952's uniform-snapshot declarations #1144

Closed
TrashPanda wants to merge 3 commits from TrashPanda/Longshot:docs/guide-retain-test-vram into main
Contributor

Type: docs · Risk: low · Tested on: Linux, game-free checks only · Needs: none

Why

main is red on the Guide screenshots check. The published Graphics image is still the right first view, but gpu/vk/vk_internal.h moved when #952 added the uniform-snapshot declarations, and the review record was not updated. Every pull request then has to explain a failure that is not its own.

What changed

The Graphics screenshot is kept. Its review record now names the vk_internal.h that was compared, as the guide's README asks when a newer source still matches the image.

  • docs/guide: in docs/images/guide/manifest.json, settings-graphics.png's reviewed_source takes the new hash of gpu/vk/vk_internal.h and a sha256: revision of the reviewed file list. review.notes says why it is retained. The PNG, its hash, captured_source and the capture fields are unchanged.

What was compared: a fresh game-free render of main a413bf1c, the same menu fixture the image was made with. The first view matches the published PNG: Quality preset selected, Frame generation Off, Frame generation by hidden, Game frame rate cap in view. The window title differs by the revision string only. HUD layout is on the Graphics page below this frame. The only reviewed input whose hash moved is vk_internal.h; the menu fixture does not call the new declarations.

Measurements

Verdict: passes: the Guide screenshots check fails on main with one issue and passes with this PR. Nothing to measure in the game.

Hardware: Ubuntu 26.04, Ryzen 7 9800X3D, 30 GB RAM, RTX 4070 Ti (not used: game-free checks)
Scene: none, no game run; the guide's screenshot check
Method: check_guide_screenshots.py --review-sources once on main and once on this branch (deterministic, so one run each)
How to reproduce: python3 -I -B scripts/check_guide_screenshots.py --review-sources, then tests/test_guide_screenshots.py

Before: main @ a413bf1c After: this PR @ 9a0262f7
check_guide_screenshots.py --review-sources 1 issue, fails passes (Launcher items NOT CHECKED, as on main)
tests/test_guide_screenshots.py 14 tests OK 14 tests OK
main:    REVIEW REQUIRED: settings-graphics.png: gpu/vk/vk_internal.h changed since reviewed revision sha256:3cef2543...
         Guide screenshot check failed: 1 issue(s).
this PR: Guide screenshot checks passed for the inputs checked above; NOT CHECKED items remain outstanding.

Flags and settings

None.

Testing

Tested: on Linux (Ubuntu 26.04), the Guide screenshots check and tests/test_guide_screenshots.py on main a413bf1c and on this commit. The picture was compared by eye with the published PNG. python -I -B tests/run_all.py: 596 passed, 23 failed, 80 skipped, the same 23 that fail on main a413bf1c on this PC (test_linux_update, test_make_game_cache, test_crt_options, test_bug_report_defaults, test_damage_debug_menu, test_failed_compile_keeps_objects, test_dlss_feature_size, test_framegen_preset, test_guest_imported, test_hud_layout_row, test_lift_lookups, test_linux_preflight, test_menu_i18n, test_missing_nup, test_mods_size_table, test_pending_guest_import, test_rumble_menu, test_run_all_changed, test_upscaler_rows, test_upscaler_round_trip, test_walk, test_walk_key, test_vk_occlusion_queries). None of them reads this manifest line.

Not tested: nothing the game runs.

Must be tested: None.

Risks

What could break: nothing the game runs. If the comparison is wrong, the guide's Graphics picture is out of date.

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.
  • 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

  • AI assistance recorded with Assisted-by: / Co-Authored-By: trailers.
  • Docs updated.
**Type:** docs · **Risk:** low · **Tested on:** Linux, game-free checks only · **Needs:** none ## Why `main` is red on the Guide screenshots check. The published Graphics image is still the right first view, but `gpu/vk/vk_internal.h` moved when #952 added the uniform-snapshot declarations, and the review record was not updated. Every pull request then has to explain a failure that is not its own. ## What changed The Graphics screenshot is kept. Its review record now names the `vk_internal.h` that was compared, as the guide's README asks when a newer source still matches the image. - docs/guide: in `docs/images/guide/manifest.json`, `settings-graphics.png`'s `reviewed_source` takes the new hash of `gpu/vk/vk_internal.h` and a `sha256:` revision of the reviewed file list. `review.notes` says why it is retained. The PNG, its hash, `captured_source` and the capture fields are unchanged. What was compared: a fresh game-free render of main a413bf1c, the same menu fixture the image was made with. The first view matches the published PNG: Quality preset selected, Frame generation Off, Frame generation by hidden, Game frame rate cap in view. The window title differs by the revision string only. HUD layout is on the Graphics page below this frame. The only reviewed input whose hash moved is `vk_internal.h`; the menu fixture does not call the new declarations. ## Measurements **Verdict:** passes: the Guide screenshots check fails on main with one issue and passes with this PR. Nothing to measure in the game. Hardware: Ubuntu 26.04, Ryzen 7 9800X3D, 30 GB RAM, RTX 4070 Ti (not used: game-free checks) Scene: none, no game run; the guide's screenshot check Method: `check_guide_screenshots.py --review-sources` once on main and once on this branch (deterministic, so one run each) How to reproduce: `python3 -I -B scripts/check_guide_screenshots.py --review-sources`, then `tests/test_guide_screenshots.py` | | Before: main @ a413bf1c | After: this PR @ 9a0262f7 | |---|---|---| | `check_guide_screenshots.py --review-sources` | 1 issue, fails | passes (Launcher items NOT CHECKED, as on main) | | `tests/test_guide_screenshots.py` | 14 tests OK | 14 tests OK | ``` main: REVIEW REQUIRED: settings-graphics.png: gpu/vk/vk_internal.h changed since reviewed revision sha256:3cef2543... Guide screenshot check failed: 1 issue(s). this PR: Guide screenshot checks passed for the inputs checked above; NOT CHECKED items remain outstanding. ``` ### Flags and settings None. ## Testing **Tested:** on Linux (Ubuntu 26.04), the Guide screenshots check and `tests/test_guide_screenshots.py` on main a413bf1c and on this commit. The picture was compared by eye with the published PNG. `python -I -B tests/run_all.py`: 596 passed, 23 failed, 80 skipped, the same 23 that fail on main a413bf1c on this PC (`test_linux_update`, `test_make_game_cache`, `test_crt_options`, `test_bug_report_defaults`, `test_damage_debug_menu`, `test_failed_compile_keeps_objects`, `test_dlss_feature_size`, `test_framegen_preset`, `test_guest_imported`, `test_hud_layout_row`, `test_lift_lookups`, `test_linux_preflight`, `test_menu_i18n`, `test_missing_nup`, `test_mods_size_table`, `test_pending_guest_import`, `test_rumble_menu`, `test_run_all_changed`, `test_upscaler_rows`, `test_upscaler_round_trip`, `test_walk`, `test_walk_key`, `test_vk_occlusion_queries`). None of them reads this manifest line. **Not tested:** nothing the game runs. **Must be tested:** None. ## Risks **What could break:** nothing the game runs. If the comparison is wrong, the guide's Graphics picture is out of date. **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`. - [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] AI assistance recorded with `Assisted-by:` / `Co-Authored-By:` trailers. - [x] Docs updated.
docs(guide): keep the Graphics screenshot after #1107's vk_internal.h declaration, so main's Guide check passes again
Some checks failed
Website / Website on Cloudflare (pull_request_target) Has been skipped
PR description / Description follows the template (pull_request_target) Successful in 9s
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
ad9b1c7f00
Assisted-by: Claude
TrashPanda changed title from WIP: docs(guide): keep the Graphics screenshot after #1107's vk_internal.h declaration, so main's Guide check passes again to docs(guide): keep the Graphics screenshot after #1107's vk_internal.h declaration, so main's Guide check passes again 2026-11-16 15:11:59 +00:00
Member

Basic code-only review of ad9b1c7f00; informational feedback, with final approval left to another reviewer.

The original retention decision looks sound: the header change only declares test_vram_bytes(), neither the menu nor its fixture calls it, and the recorded hashes match this PR's source. The PNG and capture provenance stay unchanged. The reported 14 passing screenshot tests are appropriate evidence for this narrow metadata change.

One integration caveat before merge: current main 31f8d8be has since changed five recorded inputs: menu_i18n.h, vk_api.h, vk_internal.h, vk_menu.cpp, and vk_menu.h under gpu/vk/. This manifest update alone therefore no longer restores the source-review guard on current main. Review those newer UI/fixture changes and record a retention or recapture decision, then rerun the guide check on the integrated branch; do not merely refresh the hashes. Coordinate the same manifest with 1125, 68, and 1103 when integrating them.

No tests, builds, or fresh screenshot rendering run in this review.

Basic code-only review of ad9b1c7f00c16b0be89aef6caecaf7403d4d750f; informational feedback, with final approval left to another reviewer. The original retention decision looks sound: the header change only declares `test_vram_bytes()`, neither the menu nor its fixture calls it, and the recorded hashes match this PR's source. The PNG and capture provenance stay unchanged. The reported 14 passing screenshot tests are appropriate evidence for this narrow metadata change. One integration caveat before merge: current main `31f8d8be` has since changed five recorded inputs: `menu_i18n.h`, `vk_api.h`, `vk_internal.h`, `vk_menu.cpp`, and `vk_menu.h` under `gpu/vk/`. This manifest update alone therefore no longer restores the source-review guard on current main. Review those newer UI/fixture changes and record a retention or recapture decision, then rerun the guide check on the integrated branch; do not merely refresh the hashes. Coordinate the same manifest with [1125](https://git.magicbean.dev/MagicBeanDev/Longshot/pulls/1125), [68](https://git.magicbean.dev/MagicBeanDev/Longshot/pulls/68), and [1103](https://git.magicbean.dev/MagicBeanDev/Longshot/pulls/1103) when integrating them. No tests, builds, or fresh screenshot rendering run in this review.
Author
Contributor

Confirmed on current main df6180c3. The Graphics review record on ad9b1c7f does not match six recorded sources:

  • gpu/vk/menu_i18n.h
  • gpu/vk/vk_api.h
  • gpu/vk/vk_internal.h
  • gpu/vk/vk_menu.cpp
  • gpu/vk/vk_menu.h
  • gpu/vk/vk_texture.h

The review named the first five against main 31f8d8be. vk_texture.h has changed since. This head does not turn the Guide check green on current main. I will look at those six for a retention or a recapture before asking anyone to approve, and a hash refresh is not that review. #1125, #68 and #1103 stay in that pass.

Confirmed on current main df6180c3. The Graphics review record on ad9b1c7f does not match six recorded sources: - gpu/vk/menu_i18n.h - gpu/vk/vk_api.h - gpu/vk/vk_internal.h - gpu/vk/vk_menu.cpp - gpu/vk/vk_menu.h - gpu/vk/vk_texture.h The review named the first five against main 31f8d8be. vk_texture.h has changed since. This head does not turn the Guide check green on current main. I will look at those six for a retention or a recapture before asking anyone to approve, and a hash refresh is not that review. https://git.magicbean.dev/MagicBeanDev/Longshot/pulls/1125, https://git.magicbean.dev/MagicBeanDev/Longshot/pulls/68 and https://git.magicbean.dev/MagicBeanDev/Longshot/pulls/1103 stay in that pass.
Author
Contributor

The six files are not a retain. Between this branch and current main the Graphics page itself changed:

  • #1152 added a Graphics row, HUD layout (Screen's edges or Middle 16:9).
  • #1106 moved Threaded rendering off Graphics onto the Debug tab, and shows Frame generation by and CRT lines only when they apply.

The recorded Graphics screenshot does not show the new row and still has a row the page no longer has. Updating the review hashes would pass the check on a picture that is wrong. The screenshot has to be taken again from the menu fixture on current main. The other four files (vk_internal.h's readback and snapshot declarations, vk_texture.h's ASTC reuse fields, vk_api.h's option number, the audio playback help) do not draw that page.

This pull request stays open and is not ready for review until that new capture is on it.

The six files are not a retain. Between this branch and current main the Graphics page itself changed: - https://git.magicbean.dev/MagicBeanDev/Longshot/pulls/1152 added a Graphics row, HUD layout (Screen's edges or Middle 16:9). - https://git.magicbean.dev/MagicBeanDev/Longshot/pulls/1106 moved Threaded rendering off Graphics onto the Debug tab, and shows Frame generation by and CRT lines only when they apply. The recorded Graphics screenshot does not show the new row and still has a row the page no longer has. Updating the review hashes would pass the check on a picture that is wrong. The screenshot has to be taken again from the menu fixture on current main. The other four files (vk_internal.h's readback and snapshot declarations, vk_texture.h's ASTC reuse fields, vk_api.h's option number, the audio playback help) do not draw that page. This pull request stays open and is not ready for review until that new capture is on it.
docs(guide): keep the Graphics screenshot after #952's uniform-snapshot declarations
Some checks failed
PR description / Description follows the template (pull_request_target) Successful in 9s
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
Website / Website on Cloudflare (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
9a0262f766
A fresh render of main a413bf1c matches the published first view. The only reviewed input that moved is vk_internal.h, and the menu fixture does not call those declarations.

Assisted-by: Grok 4.7
Author
Contributor

The fresh render is in, and it matches the image main already publishes. The first view is the same: Quality preset, Frame generation Off, Frame generation by hidden, Game frame rate cap in view. HUD layout sits further down the Graphics page, outside this frame. The window title is the only pixel difference, and that is the revision string.

The Guide check on main a413bf1c fails for one file, gpu/vk/vk_internal.h, from #952's uniform-snapshot declarations. The menu fixture does not call them. #1144 now only records that hash. The PNG is unchanged. The guide check passes on 9a0262f7. The full suite is 596 passed, 23 failed, 80 skipped, the same 23 as main on this PC.

The fresh render is in, and it matches the image main already publishes. The first view is the same: Quality preset, Frame generation Off, Frame generation by hidden, Game frame rate cap in view. HUD layout sits further down the Graphics page, outside this frame. The window title is the only pixel difference, and that is the revision string. The Guide check on main a413bf1c fails for one file, gpu/vk/vk_internal.h, from #952's uniform-snapshot declarations. The menu fixture does not call them. https://git.magicbean.dev/MagicBeanDev/Longshot/pulls/1144 now only records that hash. The PNG is unchanged. The guide check passes on 9a0262f7. The full suite is 596 passed, 23 failed, 80 skipped, the same 23 as main on this PC.
TrashPanda changed title from docs(guide): keep the Graphics screenshot after #1107's vk_internal.h declaration, so main's Guide check passes again to docs(guide): keep the Graphics screenshot after #952's uniform-snapshot declarations 2026-11-16 22:16:50 +00:00
Author
Contributor

Superseded: main @ 544229a2 passes check_guide_screenshots.py --review-sources by itself (the Graphics screenshot's review record was updated on main), so this change has nothing left to fix and now conflicts. Reopen if the check goes red for the same reason again.

Superseded: main @ 544229a2 passes check_guide_screenshots.py --review-sources by itself (the Graphics screenshot's review record was updated on main), so this change has nothing left to fix and now conflicts. Reopen if the check goes red for the same reason again.
TrashPanda closed this pull request 2026-11-17 13:38:48 +00:00
Some checks failed
PR description / Description follows the template (pull_request_target) Successful in 9s
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
Website / Website on Cloudflare (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

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!1144
No description provided.