Skip to content

docs: stop duplicating the engine pin in the README - #6

Open
geisten wants to merge 1 commit into
mainfrom
docs/engine-pin
Open

geisten wants to merge 1 commit into
mainfrom
docs/engine-pin

Conversation

@geisten

@geisten geisten commented Sep 21, 2026

Copy link
Copy Markdown
Owner

What

The README's make deps paragraph named the pinned commit inline and then, two sentences later, said the pin lives only in mk/config.mk. Both statements cannot stay true, and the copy is the one that rots — it read 9030b783, while GEIST_REV had already moved to b78df97f (both 2026-09-07, one commit apart).

Change

Name the variable instead of the value: the paragraph now points at mk/config.mk (GEIST_REV) and says to read it there rather than from a copy that can drift. Nothing else in the build or the fetch behaviour changes.

This is the fix the README's own sentence already asked for — one source of truth, nothing to keep in sync — rather than updating the hash and waiting for the next drift.

Testing

Documentation only; no build inputs touched. mk/config.mk is unchanged, so make deps still fetches exactly the commit it fetched before.


Noticed while comparing the documented pin against the configured one across the geisten repos.

🤖 Generated with Claude Code

https://claude.ai/code/session_01LkBr39Z2JxHU1SL63VyPC9


Generated by Claude Code

The README named the pinned commit and then, two sentences later, said the
pin lives only in mk/config.mk. The copy drifted: it read 9030b783 while
GEIST_REV had moved on to b78df97f. Name the variable instead of the hash,
so there is one place to read and nothing to keep in sync.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01LkBr39Z2JxHU1SL63VyPC9
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants