docs(oot): say what x9 holds at the Scarecrow recording cut #268
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!268
Loading…
Reference in a new issue
No description provided.
Delete branch "mooki/Longshot:fix/scarecrow-x9-comment"
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, Core i9-13900K, no GPU used · Needs: none
Why
The review of #78 asked that the comment at the Scarecrow recording site say what x9 holds there, so the next reader does not have to go to the lift to see why three sites can share one remainder.
What changed
This adds the explanation the review asked for as a source comment above one table entry. Nothing that runs changes: the comment sits inside the patch table's text and the table's entries are untouched.
f_832b6840entry ofWHOLE_SITESinnx2/oot_patches.pynow says that x9 is the elapsed counter's address at that cut, why, and that it is the field the other two Scarecrow sites reach as x19 + 0x265fc. A comment only: no entry of the table changed.One difference from the wording suggested in the review ("x19 + 0x265fc here"): in this function the object pointer is still in x0, so the comment says x0 + 0x265fc and then names the x19 form of the other two sites.
Measurements
Verdict: nothing to measure: a comment in a source file. The syntax tree of
nx2/oot_patches.py(which leaves comments out) is the same on main5e072fc8cand on this head, and the whole game-free suite on this head has the same totals as main (542 passed, 3 failed, 16 skipped), with the same three failures, which are main's own.Branch state: on main
5e072fc8c2adadba5ea610148be1c47800ba0cca; headdb58c774c688923310c0dd0192202b0c8242c948; whole game-free suite on this head:542 passed, 3 failed, 16 skipped(main5e072fc8c2adadba5ea610148be1c47800ba0cca:542 passed, 3 failed, 16 skipped). The 3 failing tests fail on main the same way:tests/test_framegen_resources.py,tests/test_module_ids.py,tests/test_pad_layout.py. The commits are unchanged by rebases apart from the results table.Commits: main
5e072fc8c2(2026-11-14); this PR fix/scarecrow-x9-comment @db58c774c6. The two focused tests and the earlier syntax-tree value below ran on mainf3fe1763dd(2026-11-13) and this PR's earlier head 8703a58866fdbaf3285a110baa6153c43e1b28a8.Hardware: Core i9-13900K, 96 GB RAM, Arch Linux 7.2.15. No GPU and no game needed.
Scene: none; a source comment.
Method: the two tests that read this table, run main, this PR, main, this PR; and the file's syntax tree (Python's
ast.dump, which leaves comments out) compared between the two commits. The tree comparison was repeated for the current commits, and the whole game-free suite was run on main and on this head.How to reproduce: on each commit,
python -I -B tests/test_scarecrow_timing.pyandpython -I -B tests/test_frame_whole.py; for the tree,python -c "import ast,hashlib,sys; print(hashlib.sha256(ast.dump(ast.parse(open('nx2/oot_patches.py', encoding='utf-8').read())).encode()).hexdigest()[:16])". The hashes are from Python 3.14, becauseast.dumpdiffers between Python versions.5e072fc8cdb58c774c6nx2/oot_patches.py(sha256, first 16 hex digits, Python 3.14)Earlier, on the commits before the carries, the two tests that read the table ran twice each and the tree was the same on both sides. That tree differs from the one above only because main's
nx2/oot_patches.pychanged in between; within each pair the two trees are equal.f3fe1763tests/test_scarecrow_timing.py, 2 runs eachtests/test_frame_whole.py, 2 runs eachnx2/oot_patches.py(sha256, first 16 hex digits)The output of those runs:
Screenshots
Nothing on screen.
Flags and settings
None.
Testing
Tested: on this exact head, the whole game-free suite (
python -I -B tests/run_all.py) gave 542 passed, 3 failed, 16 skipped, the same totals as main5e072fc8c; the three failures are main's own:tests/test_framegen_resources.py,tests/test_module_ids.pyandtests/test_pad_layout.py. The suite includestests/test_scarecrow_timing.pyandtests/test_frame_whole.py, and neither is among its failures. The syntax-tree comparison above is for the current pair. The two tests' own runs above, on Arch Linux, are from the earlier commits. The carry onto main5e072fc8cleft the commit unchanged (a comparison of the two ranges shows it identical). Before writing the comment I read the liftedf_832b6840of a Linux build of main to check what it claims: x8 is set to x0 + 0x26000 at the function's entry; the cut at 0x832b6af8 is entered two ways, by falling through and from 0x832b6e00, and each sets x9 to x8 + 1532 immediately before; the one branch that reuses x8 for something else returns without reaching the cut; and the store at 0x832b6dac, right after the cut, writes the new count through x9.Not tested: nothing in the game and no build: the patch table is the same on both commits (the tree hash above), so the lift's edits are the same. The full game-free suite on main
a55fc6cf2was not run; this head's diff merges into it without a conflict.Must be tested: None.
Risks
What could break: no behaviour changes. One cost to weigh:
nx2/oot_patches.pyis one of the lift's inputs, so I expect a build to lift again once after this merges, as after any change to that file. If that is not worth it for a comment, this can wait and ride along with the next change to the file.Turning it off: reverting the commit is enough.
Compatibility: Nothing changes for players or saves: no entry of the patch table changed. A build lifts again once after this merges, as said above.
Reviewer notes
The four comment lines above the
f_832b6840entry are the whole change.Issues
See #78
Checklist
Everyone
type(scope): description) of the status line's type.main: on5e072fc8c(2026-11-14) at the last carry, without a conflict; main has moved since (a55fc6cf2was checked), and this head's diff merges into it without a conflict (not rebased).python -I -B tests/run_all.pypasses (any failure that also fails onmainis named). On this head: 542 passed, 3 failed, 16 skipped, and the 3 failures also fail on main5e072fc8c, named under Measurements.third_party/untouched (a new folder with aPROVENANCE.mdinstead).When it applies
Assisted-by:/Co-Authored-By:trailers.New on this forge; not opened on GitHub.
Assisted-by: GPT-6 Astra
Co-Authored-By: GPT-6 Astra [email protected]
Head
7497f0828on main514591a30; the whole game-free suite on it: 517 passed, 1 failed, 15 skipped. A comment only, as asked in the review of #78; the description says how the claim in the comment was checked against the lifted function and why it names x0 where the review's suggestion named x19.WIP: docs(oot): say what x9 holds at the Scarecrow recording cutto docs(oot): say what x9 holds at the Scarecrow recording cut8703a588667497f082837497f08283db58c774c6Carried onto main
5e072fc8c; new headdb58c774c. This carry is mechanical: every commit replays unchanged, with no conflicts. The whole suite on this exact head: 542 passed, 3 failed, 16 skipped; its only failures are main's owntests/test_pad_layout.py,tests/test_module_ids.pyandtests/test_framegen_resources.py.The description is moved to the current template. The earlier one no longer passed the description check since #571 changed the template: it had no status line, no Risks section, no Must be tested part and no Everyone checklist, and its measurement columns named no commits.
Nothing else changed. The head is still
db58c774c6, with no new commit and no push, and the code and the measurements are the same. The measurement table now names main5e072fc8cand this head. The two focused runs from the earlier commits stay, marked with theirs.The syntax tree of
nx2/oot_patches.pyis the same on main5e072fc8cand on this head (23278eff46b7038f, Python 3.14). The whole game-free suite on this head is the result from my comment of 2026-11-14: 542 passed, 3 failed, 16 skipped, the same as main5e072fc8c, with the same three failures. I did not rerun the suite on maina55fc6cf2; this head's diff merges into it without a conflict.View command line instructions
Checkout
From your project repository, check out a new branch and test the changes.