Skip to content

chore: add 'mmap' to cspell dictionary#3751

Merged
bdero merged 1 commit into
mainfrom
bdero/cspell-fix-main
May 8, 2026
Merged

chore: add 'mmap' to cspell dictionary#3751
bdero merged 1 commit into
mainfrom
bdero/cspell-fix-main

Conversation

@bdero
Copy link
Copy Markdown
Member

@bdero bdero commented May 8, 2026

Summary

Unblocks CSpell on main. The 1.6.98 entry in RELEASE_NOTES.md references mmap (the Unix syscall) when describing the Android updater change to mmap libapp.so out of the APK; cspell's full-repo scan in .github/workflows/main.yaml flags the word and the CSpell GitHub-Actions check has been failing on main for every push since that release note landed.

What this changes

One line: adds mmap to the alphabetical word list in cspell.config.yaml, between mktemp and mocktail.

   - mktemp
+  - mmap # Unix `mmap` syscall — referenced in RELEASE_NOTES (libapp.so mmap-from-APK)
   - mocktail

Why the global config and not inline-scoping

RELEASE_NOTES.md already has an inline <!-- cspell:words ... --> directive at the top, so inline-scoping was an option. I went with the global config because:

  • mmap is a generic Unix term (sits naturally next to mktemp in the existing list).
  • The Rust updater's mmap work is likely to surface in future Dart code, comments, log messages, or release notes — adding it once globally avoids whack-a-mole later.
  • Other syscalls / low-level terms (dyld, dylib, mktemp) live in the global config too; this matches the convention.

Verification

gh api repos/shorebirdtech/shorebird/check-runs/<id>/annotations for the most recent failing CSpell run on main reported a single annotation:

RELEASE_NOTES.md:13:14 — Unknown word (mmap)

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-repo CSpell (Shorebird-internal CI) inherits this main failure.

Test plan

  • Annotation contents inspected on the latest failing CSpell run for main.
  • Word added in alphabetical position next to existing similar entries.
  • CI: CSpell now green on this PR (will land on push).

@bdero bdero added chore Routine maintenance, infra, or non-feature work ci Changes to continuous integration labels 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).
@bdero bdero force-pushed the bdero/cspell-fix-main branch from d7044fc to 1f6c865 Compare May 8, 2026 20:57
@bdero bdero enabled auto-merge (squash) May 8, 2026 20:58
@bdero bdero merged commit 6650254 into main May 8, 2026
15 checks passed
@bdero bdero deleted the bdero/cspell-fix-main branch May 8, 2026 20:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore Routine maintenance, infra, or non-feature work ci Changes to continuous integration

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants