docs(guide): keep the Graphics screenshot after #1107's vk_internal.h declaration, so main's Guide check passes again #1144

Open
TrashPanda wants to merge 1 commit 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 has been red since #1107 merged: the Guide screenshots check fails on every push and on every pull request, so
each PR author has to explain a failure that isn't theirs (#498, #822 and #823 already do). #1102 recorded the
Graphics screenshot's reviewed sources at 10:15 UTC; #1107 merged ten minutes later and added a declaration to
gpu/vk/vk_internal.h, one of the files that review fingerprints. Each PR passed against its own base, so the
conflict only showed once both were on main.

What changed

The Graphics screenshot is kept, and its review record now names the reviewed vk_internal.h, as the guide's README
asks for an implementation-only change ("Retain the capture only after comparison; record the newer reviewed
revision/hashes and the reason").

  • docs/guide: in docs/images/guide/manifest.json, settings-graphics.png's reviewed_source takes main 71b1edd8 as
    its revision and vk_internal.h's new SHA-256, and review.notes says why it is retained. The PNG, its hash,
    captured_source and the capture fields are unchanged.

What was compared: #1107's only change to vk_internal.h is the declaration of test_vram_bytes() (the
RX_VK_TEST_VRAM_MB test switch). It is called from vk_main.cpp, vk_vma.cpp and vk_memory.cpp only; neither
vk_menu.cpp nor the menu fixture (scripts/screenshots/menu.cpp) calls it, and no pictured row, value, help text or
navigation changes. No other recorded source for this image changed.

Measurements

Verdict: passes: the Guide screenshots check fails on main with one issue and passes with this PR; nothing to
measure in the game (a review record only).

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: the Guide screenshots workflow's three commands, 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 @ 71b1edd8 After: this PR @ ad9b1c7f
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:f347a8b4...
         Guide screenshot check failed: 1 issue(s). Review the affected UI and guide before updating review hashes.
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 three steps of .forgejo/workflows/guide-screenshots.yml on main and on this
branch. The whole python -I -B tests/run_all.py: 583 passed, 16 failed, 78 skipped. The same 16 also fail on a
clean main on this PC (test_walk_key, test_lift_lookups, test_make_game_cache, test_linux_update,
test_vk_occlusion_queries and 11 others): this PC has GCC 15 and Python 3.14, newer than CI's Ubuntu 24.04. None of
them reads the manifest.

Not tested: a fresh render of the screenshot: not needed for a retained image whose pictured inputs did not change.

Must be tested: None.

Risks

What could break: nothing the game runs. If the review 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` has been red since #1107 merged: the Guide screenshots check fails on every push and on every pull request, so each PR author has to explain a failure that isn't theirs (#498, #822 and #823 already do). #1102 recorded the Graphics screenshot's reviewed sources at 10:15 UTC; #1107 merged ten minutes later and added a declaration to `gpu/vk/vk_internal.h`, one of the files that review fingerprints. Each PR passed against its own base, so the conflict only showed once both were on `main`. ## What changed The Graphics screenshot is kept, and its review record now names the reviewed `vk_internal.h`, as the guide's README asks for an implementation-only change ("Retain the capture only after comparison; record the newer reviewed revision/hashes and the reason"). - docs/guide: in `docs/images/guide/manifest.json`, `settings-graphics.png`'s `reviewed_source` takes main 71b1edd8 as its revision and `vk_internal.h`'s new SHA-256, and `review.notes` says why it is retained. The PNG, its hash, `captured_source` and the capture fields are unchanged. What was compared: #1107's only change to `vk_internal.h` is the declaration of `test_vram_bytes()` (the `RX_VK_TEST_VRAM_MB` test switch). It is called from `vk_main.cpp`, `vk_vma.cpp` and `vk_memory.cpp` only; neither `vk_menu.cpp` nor the menu fixture (`scripts/screenshots/menu.cpp`) calls it, and no pictured row, value, help text or navigation changes. No other recorded source for this image changed. ## Measurements **Verdict:** passes: the Guide screenshots check fails on main with one issue and passes with this PR; nothing to measure in the game (a review record only). 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: the Guide screenshots workflow's three commands, 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 @ 71b1edd8 | After: this PR @ ad9b1c7f | |---|---|---| | `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:f347a8b4... Guide screenshot check failed: 1 issue(s). Review the affected UI and guide before updating review hashes. 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 three steps of `.forgejo/workflows/guide-screenshots.yml` on main and on this branch. The whole `python -I -B tests/run_all.py`: 583 passed, 16 failed, 78 skipped. The same 16 also fail on a clean main on this PC (`test_walk_key`, `test_lift_lookups`, `test_make_game_cache`, `test_linux_update`, `test_vk_occlusion_queries` and 11 others): this PC has GCC 15 and Python 3.14, newer than CI's Ubuntu 24.04. None of them reads the manifest. **Not tested:** a fresh render of the screenshot: not needed for a retained image whose pictured inputs did not change. **Must be tested:** None. ## Risks **What could break:** nothing the game runs. If the review 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 are pending
CI / Conventional Commit title (pull_request) Blocked by required conditions
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Blocked by required conditions
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Blocked by required conditions
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Blocked by required conditions
CI / Workflow lint (actionlint) (pull_request) Blocked by required conditions
Guide screenshots / Guide images and local UI source review (pull_request) Blocked by required conditions
Third-party parts / As their notes say (pull_request) Blocked by required conditions
Third-party parts / The same as upstream (pull_request) Blocked by required conditions
Website / Website on Cloudflare (pull_request) Blocked by required conditions
Website / Website on Cloudflare (pull_request_target) Has been skipped
PR description / Description follows the template (pull_request_target) Successful in 9s
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
Some checks are pending
CI / Conventional Commit title (pull_request) Blocked by required conditions
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Blocked by required conditions
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Blocked by required conditions
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Blocked by required conditions
CI / Workflow lint (actionlint) (pull_request) Blocked by required conditions
Guide screenshots / Guide images and local UI source review (pull_request) Blocked by required conditions
Third-party parts / As their notes say (pull_request) Blocked by required conditions
Third-party parts / The same as upstream (pull_request) Blocked by required conditions
Website / Website on Cloudflare (pull_request) Blocked by required conditions
Website / Website on Cloudflare (pull_request_target) Has been skipped
PR description / Description follows the template (pull_request_target) Successful in 9s
This pull request doesn't have enough approvals yet. 0 of 1 approvals granted.
Some workflows are waiting to be reviewed.
This branch is out-of-date with the base branch
You are not authorized to merge this pull request.
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u 'docs/guide-retain-test-vram:TrashPanda-docs/guide-retain-test-vram'
git switch 'TrashPanda-docs/guide-retain-test-vram'
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
1 participant
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.