Repository navigation
docs/engine/engine.json: the Wine modules' patches and code, for the site's /wine - #27
Merged
Merged
Conversation
…site's /wine The site's /wine page kept its code by hand: eight excerpts pinned to five old commits. tools/export-engine-docs.py now writes docs/engine/engine.json from engine/patches/, as tools/export-fix-docs.py writes fixes.json. The JSON holds every series and patch (name, file, what it does, the dlls/ folders it changes, a permalink to its last commit) and the excerpts. What only a person can say stays in two hand-written files: - docs/engine/patches.json gives each patch a line. The patches have no Subject: header, and a patch without a line fails. - docs/engine/excerpts.json names a function to cut, or a hunk to show. An excerpt runs from the comment above the function to its closing brace, without the patch's +, and is pinned to the last commit that changed its file. Cut at the commits the site pinned, all eight came out identical to the site's wine-code.json: the same lines and the same code. The Engine docs workflow runs --check on every pull request and push to main that touches engine/ or docs/engine/, so no version ships with /wine behind. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Decided 2026-10-25 (hub macgamefix/noticias-verificadas, w01): the site's /wine page reads its patch list and code from the repository, kept up to date by an exporter and a check.
tools/export-engine-docs.py(standard library only, liketools/export-fix-docs.py) writesdocs/engine/engine.json. With--checkit fails when that file is not what the sources say.buildslists every series inengine/patches/with its patches in name order. Each patch has its name, file,subject, themodules(thedlls/folders it changes),commitand a permalink.excerptshas the same shape as the site'swine-code.json, pluscommit, withlanguageset tocordiff.docs/engine/patches.jsongives a subject line for each patch. The patches have noSubject:header, and a patch without a line fails.docs/engine/excerpts.jsonholds the eight keys of the site.cap-xinputis a hunk found by a pattern instead of a line range, so it follows the patch if lines move..github/workflows/engine-docs.ymlruns--checkon pull requests and pushes to main that touchengine/ordocs/engine/. It is the repository's first workflow.Tested
wine-code.json: the same start and end lines, and the same code.--checkpasses on this branch: 2 series, 18 patches, 8 excerpts.🤖 Generated with Claude Code