docs(source_coverage): config_tu/ is out of scope on purpose, not by omission - #2048
Merged
Merged
Conversation
…omission `module_of()` cited `config_tu/` as a layout it handles, but both scanners -- entries_from_tree() and entries_from_ref() -- are hard scoped to CONFIG_DIR, so that path can never be passed in. The comment advertised coverage the gate does not have and must not have. tu_config.py generates config_tu/ as a PARALLEL dsd root for the TU-shaped treemap experiment and states its own contract: "config/** /delinks.txt remains the sole authority over what mwccarm compiles." rombuild.py reaches that root only behind an opt-in --module flag. Measured on main: 8 delinks files, 29 entries, ZERO marked `complete`. Widening the scan would not find one source-built byte -- it would import 29 unenrolled entries and their false alarms. Comment only. No behaviour change: tools.test_source_coverage 25/25, and the tool still reports 2,067,148 B across 74 modules / 10,973 ranges, identical to main.
✅ PR validation — Passednoverify: no source/build-data changes in this PR Each changed |
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.
Comment only, no behaviour change. Filed because the comment was actively
misleading in a gate, which is the failure class this tree keeps getting bitten by.
What it said vs. what is true
module_of()carried:But
config_tu/can never be passed tomodule_of(). Both scanners are hard-scoped toCONFIG_DIR = "config":So the function advertised handling for a root neither caller can reach.
Why that is worth a commit
The obvious "fix" on reading it is to widen the scanners so the
config_tu/branchfinally does something. That would be wrong, and
tu_config.pysays so in its owncontract:
rombuild.pyreaches that root only behind an opt-in--moduleflag, for the TU-shapedtreemap experiment.
I measured what widening would actually buy, rather than arguing it:
config_tu/**/delinks.txton maincompleteZero.
completeis the whole ballgame — with it mwccarm compiles the source, without itdsd supplies the object from ROM bytes. So widening the scan finds no source-built
byte at all; it imports 29 unenrolled entries and the false alarms that come with them.
The new comment records that number so the next reader does not have to re-derive it.
Why I was looking at this file
Chasing the same question that produced #2046: what actually notices when dsd stops
compiling a range from source and hands it back to the retail cartridge.
config_tu/came up as a candidate blind spot. It is not one — it is correctly out of scope — and
this commit is the difference between "out of scope" and "looks like an oversight."
Verification
Byte-for-byte the figure main reports, which is the point: a comment change must move
nothing. Pre-push green:
port_refcheck405/405,check_src_tu90/90,duplicate-sources 11199 stems none doubled. No compiled source touched, so there is no
byte claim here and none is made.