MdePkg: Fix Spelling Errors and Enforce Spell Check#12459
MdePkg: Fix Spelling Errors and Enforce Spell Check#12459os-d wants to merge 23 commits intotianocore:masterfrom
Conversation
github-actions
bot
added
the
impact:breaking-change
tianocore-assign-reviewers
bot
requested review from
AydenMeng,
Benny3345678,
BritChesley,
Javagedes,
abdattar,
ajfish,
ardbiesheuvel,
arunsbaskaran,
changab,
dandanbi,
gguo11837463,
jameslu8,
jkolakow,
jyao1 and
karthikkabbigere1
tianocore-assign-reviewers
bot
requested review from
LeviYeoReum,
MarsDoge,
kilaterlee,
kprakas2,
kraxel,
kuqin12,
leiflindholm,
lgao4,
makubacki,
mdkinney,
mikebeaton,
nicklela and
pierregondois
Fix spelling errors in Mtftp4 definitions. Update the consumer in NetworkPkg/Mtftp4Dxe accordingly. Continuous-integration-options: PatchCheck.ignore-multi-package Signed-off-by: Oliver Smith-Denny <osde@microsoft.com>
Fix a spelling error in the DHCP4 definitions and fix up the consumers in NetworkPkg. Continuous-integration-options: PatchCheck.ignore-multi-package Signed-off-by: Oliver Smith-Denny <osde@microsoft.com>
|
@leiflindholm CI is passing so I've moved this out of draft. Please continue your review |
pierregondois
left a comment
pierregondois
left a comment
There was a problem hiding this comment.
Hello Oliver,
Just one comment, also I made #12470 to help reducing the output of cspell
|
Put up a PR to fix edk2-platforms after this goes in: tianocore/edk2-platforms#977. Despite all the changes, the blast radius is pretty low, a lot of the definition changes are not widely used. |
|
@mikebeaton thanks for the reviews. Let me know when you are done and I will apply the requested changes from you and @pierregondois to not change the tree out from under you while reviewing. |
Done. Thanks. |
Thanks, for any other reviewers, I recommend pausing until I push up the current requested changes. If anyone else is actively reviewing, let me know, I will hold off pushing changes until your review is finished. |
Update the global cspell dictionary with allowed words from MdePkg. Signed-off-by: Oliver Smith-Denny <osde@microsoft.com>
|
@mikebeaton @pierregondois I have addressed your feedback, please re-review when you have a chance. |
This fixes all non-breaking spelling errors in MdePkg. Signed-off-by: Oliver Smith-Denny <osde@microsoft.com>
Now that all spelling errors have been fixed, disable AuditOnly mode to catch future spelling errors in PR gates. Signed-off-by: Oliver Smith-Denny <osde@microsoft.com>
4 participants
Description
Currently, there are some thousands of spell check failures in MdePkg. The spell check plugin is also in audit only mode, so new failures are not caught. Thousands of lines of the CI build log are dedicated to spelling failures and are very annoying to scroll through. After this change, the MdePkg CI build log is 7,500 lines shorter.
Each associated area is split up into a separate commit where actual code changes are made (e.g. defines, structure fields, etc.). Where relevant, consumers are updated in the same commit to prevent having to redefine and then come back and drop the old definition.
All non-code change spelling fixes (i.e. comments) are in the final commit, which also adds all the words to ignore to the global cspell dictionary. The final commit disables AuditOnly in MdePkg so that new spelling errors will break the build and be caught.
How This Was Tested
N/A.
Integration Instructions
Some defines/structures/enums, etc. have had spelling fixes applied to them. Consumers should update accordingly.