Repository navigation
board_spec: stop tracking resolved combinations and print them on demand - #365
Merged
Merged
Conversation
generated/resolved/ held every revision/runtime combination of every board,
fully expanded (87 files, about 34,600 lines). No generator, the firmware or
the editor reads these files: the wiring, spec, pin table and docs generators
and the editor expand the catalog in memory. For most boards the snapshot was
close to a copy of the source JSON, so each catalog edit appeared twice and
had to be regenerated before check would pass.
- check still expands and validates every combination in memory, but no
longer compares against checked-in snapshots. chip and storage, which no
generator reads, are asserted directly for representative boards.
- resolve prints all combinations of a board as one JSON array of
{ combination, board } on stdout. --out <dir> writes the previous per-
combination files for local inspection; no tool reads that export.
- Revision and composition docs, previously written as a side effect of
resolve, are generated by the new emit-docs command (all boards when no file
is given). The other generated outputs are unchanged.
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
2 participants
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.
extras/board_spec/generated/resolved/held every revision/runtime combination of every board, fully expanded (87 files, about 34,600 lines). Nothing reads these files: the wiring, spec, pin-table and docs generators and the editor all expand the catalog in memory, and the firmware never sees them. For most boards the snapshot is close to a copy of the source JSON, so every catalog edit showed up twice and had to be regenerated beforecheckpassed.Changes
checkstill expands and validates every combination in memory; it no longer compares against checked-in snapshots.chipandstorage, which no generator reads, are asserted directly for representative boards (with and without PSRAM, quad and octal).resolve <board>prints all combinations as one JSON array of{ "combination", "board" }on stdout.--out <dir>writes the previous per-combination files for local inspection; no tool reads that export.generated/resolved/is git-ignored.resolve, come from the newemit-docscommand (all boards when no file is given). README updated.The other generated outputs (detection wiring, M5Unified pin tables, docs, the editor bundle) are byte-identical, and the
resolveoutput matches the removed files for all 87 combinations. No firmware change.Testing
npm test/npm run checkinextras/board_spec,sh test/board_detect/run.sh