chore: add 'mmap' to cspell dictionary#3751
Merged
Merged
Conversation
eseidel
approved these changes
May 8, 2026
The 1.6.98 release notes reference mmap (the Unix syscall) when describing the Android updater change to mmap libapp.so out of the APK. The full-repo cspell scan on every PR was failing on this word; adding it to the global dictionary unblocks the check on main and avoids inline-scoping in RELEASE_NOTES (since mmap is likely to recur in future code/comments).
d7044fc to
1f6c865
Compare
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.
Summary
Unblocks CSpell on
main. The1.6.98entry inRELEASE_NOTES.mdreferencesmmap(the Unix syscall) when describing the Android updater change to mmaplibapp.soout of the APK; cspell's full-repo scan in.github/workflows/main.yamlflags the word and theCSpellGitHub-Actions check has been failing onmainfor every push since that release note landed.What this changes
One line: adds
mmapto the alphabetical word list incspell.config.yaml, betweenmktempandmocktail.- mktemp + - mmap # Unix `mmap` syscall — referenced in RELEASE_NOTES (libapp.so mmap-from-APK) - mocktailWhy the global config and not inline-scoping
RELEASE_NOTES.mdalready has an inline<!-- cspell:words ... -->directive at the top, so inline-scoping was an option. I went with the global config because:mmapis a generic Unix term (sits naturally next tomktempin the existing list).mmapwork is likely to surface in future Dart code, comments, log messages, or release notes — adding it once globally avoids whack-a-mole later.dyld,dylib,mktemp) live in the global config too; this matches the convention.Verification
gh api repos/shorebirdtech/shorebird/check-runs/<id>/annotationsfor the most recent failing CSpell run onmainreported a single annotation:That annotation is the only failure surfaced by the check, so this should fully unblock CSpell on
main. Discovered while debugging cspell on #3750 — that PR's incremental-only check (GitHub Actions) is green; the full-repoCSpell(Shorebird-internal CI) inherits thismainfailure.Test plan