chore: fix typos repo-wide and close the CI spell check gap#833
Open
ananos wants to merge 3 commits into
Open
Conversation
Fix misspellings and grammar slips across the docs, README and CHANGELOG. Apart from wording, there are three corrections that change meaning: - name Solo5-hvt and Solo5-spt explicitly in the MirageOS and Rumprun monitor lists instead of two identical Solo5 links - fix the inverted Go version requirement wording in the installation guide (1.20.6 or later, not earlier) - fix the monitors-build repository name in the installation guide Signed-off-by: Anastassios Nanos <ananos@nubificus.co.uk>
Fix misspellings in Go comments, in two error message strings and in a Makefile comment. No functional change: the error values are only compared as sentinels, never by text. go build and go vet pass. Signed-off-by: Anastassios Nanos <ananos@nubificus.co.uk>
The cspell ignore pattern for inline code also matched across newlines, pairing the closing backtick of one code span with the opening backtick of the next one. In backtick-heavy documents this hid most of the prose from the spell checker. Restrict the pattern to a single line and drop a duplicate entry of it. Also clean up the project dictionary: drop entries that were added for words that are actually misspellings (now fixed in the tree) and add the legitimate terms that the wider net now surfaces. Fixes: #832 Signed-off-by: Anastassios Nanos <ananos@nubificus.co.uk>
✅ Deploy Preview for urunc ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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.
Description
This PR sweeps the repository for typos and grammar errors and fixes the reason CI was not catching them.
Typo and grammar fixes (
docs:andstyle:commits):rirecracker->firecracker,lastest->latest,Fotran->Fortran,Cloud-HYpervisor->Cloud-Hypervisor, "in the same directly" -> "directory") and a number of grammar slips (subject-verb agreement, "a initrd" -> "an initrd", "Except of" -> "Apart from", missing sentence breaks).docs/unikernel-support.md: the MirageOS and Rumprun monitor lists linkedSolo5twice; they now name Solo5-hvt and Solo5-spt explicitly.docs/installation.md: "any earlier version of Go 1.20.6 should be sufficient" inverted the intended meaning; it now reads "any version of Go 1.20.6 or later". Alsomonitor-builds->monitors-build(the actual repository name)."this a queue proxy container","Operation not support"). No functional change: both error values are only compared as sentinels, never by text.Why CI missed these (
ci:commit):`[^`]+`in.github/linters/.cspell.jsonmatched across newlines, pairing the closing backtick of one code span with the opening backtick of the next one. In backtick-heavy pages this hid most of the prose from cspell entirely. The pattern is now restricted to a single line and a duplicate entry was dropped. This alone surfaced 25 previously hidden words.urunc-dict.txtwere real misspellings added to silence the checker (burdain,levarage,secomp,triger,isues,vlaid, ...). These are removed and their occurrences fixed. Entries that look like typos but are required by cspell's tokenizer were kept (e.g.urunce/etestingfrompackage urunce2etesting,Prettyfierfrom logrus'sCallerPrettyfierfield,scontroller/sworkerfrom thek0scontroller/k0sworkerservice names).misspellin golangci-lint runs withonly-new-issues: true, so pre-existing typos in Go code are never reported, and grammar-level errors ("the followings", "instructions fo using":foandfollowingsare valid en_US dictionary words) are invisible to any spell checker. Those categories were fixed manually here and will need human review to catch in the future.Related issues
How was this tested?
All testing on Linux amd64 (Ubuntu 24.04, containerd 2.3.3, devmapper), plus spell/commit lint locally:
cspell --config .github/linters/.cspell.json: 0 issues on 158 files with the stricter regex.commitlint --from=origin/mainwith the repo config: all three commits pass.go build ./... && go vet ./... && gofmt -l: clean; the Go diff touches only comments and the two string literals.make lint(golangci-lint v2.9 container): reports 4 findings (1 ineffassign, 3 unused) that are byte-identical on pristineorigin/main; this branch introduces no new findings (the CI gate runs withonly-new-issues: true).make unittest): pass. (When run as root,TestCopyFile/TestMoveFilefail because root bypasses the permission denials they assert; this reproduces identically on pristinemainand is unrelated.)make test_ctr) with urunc + shim built from this branch (make+make install): all 11 specs for the working monitors on the test host (qemu, firecracker) pass. The 6 Solo5 (Hvt-*/Spt-*) specs fail with the exact same reexecRX_ERRORwhen running urunc built from pristineorigin/mainon the same host (nested-KVM environment issue, pre-existing and unrelated to this PR).LLM usage
Claude Fable 5 (via Claude Code) assisted with this PR and the associated issue, per the LLM policy. All changes were reviewed and tested by the contributor, who takes full responsibility for them.
Checklist
make lint).make test_ctr,make test_nerdctl,make test_docker,make test_crictl).