docs(guide): keep the Graphics screenshot after #1107's vk_internal.h declaration, so main's Guide check passes again #1144
No reviewers
Labels
No labels
area/accessibility
area/audio
area/input
area/install
area/menu
area/renderer
area/saves
area/tooling
area/upscaling
beanstalk: approved
beanstalk: failed
beanstalk: needs approval
beanstalk: running
beanstalk: tested
ci: approved
good first issue
gpu/amd
gpu/igpu
gpu/intel
gpu/nvidia
help wanted
kind
bug
kind
chore
kind
docs
kind
feature
kind
performance
kind
question
needs measurements
platform/linux
platform/macos
platform/steam-deck
platform/windows
preview
priority
critical
priority
high
priority
low
regression
risk
high
risk
low
risk
medium
status
blocked
status
confirmed
status
duplicate
status
invalid
status
needs-info
status
wontfix
ci: approved
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set
Reference
MagicBeanDev/Longshot!1144
Loading…
Reference in a new issue
No description provided.
Delete branch "TrashPanda/Longshot:docs/guide-retain-test-vram"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Type: docs · Risk: low · Tested on: Linux, game-free checks only · Needs: none
Why
mainhas been red since #1107 merged: the Guide screenshots check fails on every push and on every pull request, soeach 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 theconflict 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 READMEasks for an implementation-only change ("Retain the capture only after comparison; record the newer reviewed
revision/hashes and the reason").
docs/images/guide/manifest.json,settings-graphics.png'sreviewed_sourcetakes main71b1edd8asits revision and
vk_internal.h's new SHA-256, andreview.notessays why it is retained. The PNG, its hash,captured_sourceand the capture fields are unchanged.What was compared: #1107's only change to
vk_internal.his the declaration oftest_vram_bytes()(theRX_VK_TEST_VRAM_MBtest switch). It is called fromvk_main.cpp,vk_vma.cppandvk_memory.cpponly; neithervk_menu.cppnor the menu fixture (scripts/screenshots/menu.cpp) calls it, and no pictured row, value, help text ornavigation 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, thentests/test_guide_screenshots.py71b1edd8ad9b1c7fcheck_guide_screenshots.py --review-sourcestests/test_guide_screenshots.pyFlags and settings
None.
Testing
Tested: on Linux (Ubuntu 26.04), the three steps of
.forgejo/workflows/guide-screenshots.ymlon main and on thisbranch. The whole
python -I -B tests/run_all.py: 583 passed, 16 failed, 78 skipped. The same 16 also fail on aclean main on this PC (
test_walk_key,test_lift_lookups,test_make_game_cache,test_linux_update,test_vk_occlusion_queriesand 11 others): this PC has GCC 15 and Python 3.14, newer than CI's Ubuntu 24.04. None ofthem 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
type(scope): description) of the status line's type.main.python -I -B tests/run_all.pypasses (any failure that also fails onmainis named).third_party/untouched (a new folder with aPROVENANCE.mdinstead).When it applies
Assisted-by:/Co-Authored-By:trailers.WIP: docs(guide): keep the Graphics screenshot after #1107's vk_internal.h declaration, so main's Guide check passes againto docs(guide): keep the Graphics screenshot after #1107's vk_internal.h declaration, so main's Guide check passes againView command line instructions
Checkout
From your project repository, check out a new branch and test the changes.