chore: drop hardware-specific references from comments - #20
Merged
Conversation
Comments and test fixtures named the particular machines they were taken from. The technical substance is what documents the behaviour — carveout sizes, page counts, gfx targets — so that stays; only the model names and host details go. - drm, kfd, lib: describe the AMD APU by what it is rather than by model. - metal: the `vm_stat` fixture reads as a representative report rather than a capture from a named host, and the assertions no longer narrate that host's installed memory. No behaviour change; comments and doc text only. Co-Authored-By: Claude Opus 5 (1M context) <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
1 participant
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.
Comments and test fixtures named the particular machines they were taken from. This removes those references while keeping everything that documents the behaviour.
The technical substance is the part that earns its place in a comment — carveout sizes, page counts, gfx targets, the compressor distinction — so all of it stays. Only the model names and host details go.
Changes
drm.rs512 MiB on a BC-250, for instanceas little as 512 MiB, for instancedrm.rsOn a BC-250 with a 512 MiB carveoutOn an APU with a 512 MiB carveoutdrm.rsReal BC-250 readings:…as an APU reports itkfd.rsTrimmed from a real BC-250 nodeTrimmed from an AMD GPU nodekfd.rsThe BC-250 this was written againstA gfx1013 partlib.rs512 MiB of 14.5 GiB on a BC-250512 MiB of 14.5 GiB on one such partmetal.rsTrimmed from a real M2 running macOS 26.5A representative vm_stat report on a 16 KiB-page hostmetal.rs~6.2 GiB of the 8 GiB this fixture was taken froma plausible fraction of installed memory, not a multiplemetal.rswould report ~19 GiB on 8 GiBovershoots by several timesAlso drops a trailing
Detection was exercised end to end on an Apple M2 (macOS 26.5)sentence from theapple_familydocs. What remains there is the citation to Apple's published feature-set tables, which is the part a reader needs.Deliberately left alone: generic mapping documentation like
e.g. `apple8` for an M2and theApple M2 Proparser fixtures. Those name a chip to explain an API, not a machine anyone is testing on, and removing them would cost real clarity.Verification
No behaviour change — comments and doc text only.
just cipasses: 100 unit + 9 integration + 13 doctests, clippy clean under pedantic +-D warnings.🤖 Generated with Claude Code