Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Attempt to skip code in misspell #17335

Merged
merged 25 commits into from
Apr 13, 2022

Conversation

andy31415
Copy link
Contributor

Problem

We are spellchecking code in misspell, which results in strange 'words' being added to wordlist and generally creating developer overhead without a practical use (no use to say things like fHtcwcAAAAAAAAAwQAAAAAAXPMlAAAAAAA is a word)

Change overview

Uses https://facelessuser.github.io/pyspelling/configuration/#pipeline configuration to attempt to filter out code blocks (single or tripple backtics).

Removed some seemingly invalid words from the word list.

changed examples/all-clusters-app/linux/README.md since that contained code that was spellchecked, to validate if we indeed now ignore those sections. Had to manually add code sections.

Testing

Spell check may test itself.

@boring-cyborg boring-cyborg bot added the lwip label Apr 13, 2022
@andy31415 andy31415 merged commit a76f75e into project-chip:master Apr 13, 2022
@github-actions
Copy link

github-actions bot commented Apr 13, 2022

PR #17335: Size comparison from 184bda1 to d7aa3b0

Increases (19 builds for efr32, esp32, mbed, nrfconnect, telink)
platform target config section 184bda1 d7aa3b0 change % change
efr32 lighting-app BRD4161A (read only) 907716 908068 352 0.0
(read/write) 133080 133144 64 0.0
.bss 131040 131104 64 0.0
.text 907708 908060 352 0.0
BRD4161A+rpc (read only) 942084 942436 352 0.0
(read/write) 149764 149828 64 0.0
.bss 147520 147584 64 0.0
.text 942076 942428 352 0.0
window-app BRD4161A (read only) 844708 844724 16 0.0
.text 844700 844716 16 0.0
esp32 all-clusters-app c3devkit (read only) 979972 979976 4 0.0
.flash.text 979972 979976 4 0.0
m5stack (read only) 1035459 1035487 28 0.0
.flash.text 1030075 1030103 28 0.0
mbed all-clusters-app CY8CPROTO_062_4343W+release (read/write) 2478560 2479456 896 0.0
.text 1441132 1442028 896 0.1
lighting-app CY8CPROTO_062_4343W+release (read/write) 2437080 2437968 888 0.0
.text 1399652 1400540 888 0.1
lock-app CY8CPROTO_062_4343W+release (read/write) 2368516 2369412 896 0.0
.text 1331116 1332012 896 0.1
shell CY8CPROTO_062_4343W+release (read/write) 2363064 2363952 888 0.0
.text 1325636 1326524 888 0.1
nrfconnect all-clusters-app nrf52840dk_nrf52840 (read/write) 1163459 1163491 32 0.0
text 800940 800968 28 0.0
lighting-app nrf52840dk_nrf52840 (read/write) 1149615 1149647 32 0.0
text 808372 808400 28 0.0
nrf52840dk_nrf52840+rpc (read/write) 1113927 1113943 16 0.0
text 780876 780880 4 0.0
nrf52840dongle_nrf52840 (read/write) 1058111 1058127 16 0.0
text 737272 737300 28 0.0
nrf5340dk_nrf5340_cpuapp (read/write) 1052074 1052106 32 0.0
text 718492 718520 28 0.0
lock-app nrf52840dk_nrf52840 (read/write) 1049991 1050023 32 0.0
text 726120 726148 28 0.0
nrf5340dk_nrf5340_cpuapp (read/write) 952718 952750 32 0.0
text 636392 636420 28 0.0
pump-app nrf52840dk_nrf52840 (read/write) 1069827 1069859 32 0.0
text 743112 743140 28 0.0
pump-controller-app nrf52840dk_nrf52840 (read/write) 1051563 1051595 32 0.0
text 729136 729164 28 0.0
telink lighting-app tlsr9518adk80d (read/write) 801516 801524 8 0.0
text 570132 570136 4 0.0
Decreases (13 builds for cc13x2_26x2, cyw30739, linux)
platform target config section 184bda1 d7aa3b0 change % change
cc13x2_26x2 pump-app LP_CC2652R7 (read only) 648527 648519 -8 -0.0
.text 572624 572616 -8 -0.0
cyw30739 lock cyw930739m2evb_01 (read/write) 576646 576638 -8 -0.0
.app_xip_area 484892 484884 -8 -0.0
linux all-clusters-app debug (read only) 2697969 2697841 -128 -0.0
.text 2291554 2291426 -128 -0.0
bridge-app debug+rpc (read only) 1837581 1837453 -128 -0.0
.text 1570645 1570517 -128 -0.0
chip-tool debug (read only) 10683941 10683829 -112 -0.0
.text 9315669 9315557 -112 -0.0
chip-tool-no-interactive-ipv6only arm64 (read only) 10283492 10283348 -144 -0.0
.text 8667044 8666900 -144 -0.0
door-lock-app debug (read only) 2108929 2108817 -112 -0.0
.text 1766530 1766418 -112 -0.0
lighting-app debug+rpc (read only) 2313769 2313657 -112 -0.0
.text 1965266 1965154 -112 -0.0
ota-provider-app debug (read only) 2046145 2046033 -112 -0.0
.text 1717442 1717330 -112 -0.0
ota-requestor-app debug (read only) 2076521 2076409 -112 -0.0
.text 1749074 1748962 -112 -0.0
shell debug (read only) 2525825 2525713 -112 -0.0
.text 2149922 2149810 -112 -0.0
thermostat-no-ble arm64 (read only) 2353620 2353476 -144 -0.0
.text 1980496 1980352 -144 -0.0
tv-app debug (read only) 2797265 2797153 -112 -0.0
.text 2402706 2402594 -112 -0.0
Full report (43 builds for cc13x2_26x2, cyw30739, efr32, esp32, k32w, linux, mbed, nrfconnect, p6, telink)
platform target config section 184bda1 d7aa3b0 change % change
cc13x2_26x2 lock-ftd LP_CC2652R7 (read only) 640435 640435 0 0.0
(read/write) 151212 151212 0 0.0
.bss 74144 74144 0 0.0
.data 3212 3212 0 0.0
.rodata 80227 80227 0 0.0
.text 559716 559716 0 0.0
lock-mtd LP_CC2652R7 (read only) 589171 589171 0 0.0
(read/write) 146932 146932 0 0.0
.bss 69864 69864 0 0.0
.data 3212 3212 0 0.0
.rodata 80107 80107 0 0.0
.text 508572 508572 0 0.0
pump-app LP_CC2652R7 (read only) 648527 648519 -8 -0.0
(read/write) 152508 152508 0 0.0
.bss 74640 74640 0 0.0
.data 3244 3244 0 0.0
.rodata 75415 75415 0 0.0
.text 572624 572616 -8 -0.0
pump-controller-app LP_CC2652R7 (read only) 642499 642499 0 0.0
(read/write) 152176 152176 0 0.0
.bss 74344 74344 0 0.0
.data 3208 3208 0 0.0
.rodata 79051 79051 0 0.0
.text 562960 562960 0 0.0
cyw30739 light cyw930739m2evb_01 (read/write) 619042 619042 0 0.0
.app_xip_area 525752 525752 0 0.0
.bss 75956 75956 0 0.0
.data 684 684 0 0.0
.rodata 0 0 0 0.0
.text 0 0 0 0.0
lock cyw930739m2evb_01 (read/write) 576646 576638 -8 -0.0
.app_xip_area 484892 484884 -8 -0.0
.bss 74452 74452 0 0.0
.data 648 648 0 0.0
.rodata 0 0 0 0.0
.text 0 0 0 0.0
ota-requestor-no-progress-logging cyw930739m2evb_01 (read/write) 565170 565170 0 0.0
.app_xip_area 463788 463788 0 0.0
.bss 83784 83784 0 0.0
.data 564 564 0 0.0
.rodata 0 0 0 0.0
.text 112 112 0 0.0
efr32 lighting-app BRD4161A (read only) 907716 908068 352 0.0
(read/write) 133080 133144 64 0.0
.bss 131040 131104 64 0.0
.data 2040 2040 0 0.0
.text 907708 908060 352 0.0
BRD4161A+rpc (read only) 942084 942436 352 0.0
(read/write) 149764 149828 64 0.0
.bss 147520 147584 64 0.0
.data 2244 2244 0 0.0
.text 942076 942428 352 0.0
window-app BRD4161A (read only) 844708 844724 16 0.0
(read/write) 131148 131148 0 0.0
.bss 129200 129200 0 0.0
.data 1948 1948 0 0.0
.text 844700 844716 16 0.0
esp32 all-clusters-app c3devkit (read only) 979972 979976 4 0.0
(read/write) 1397578 1397578 0 0.0
.dram0.bss 62624 62624 0 0.0
.dram0.data 14420 14420 0 0.0
.flash.rodata 201616 201616 0 0.0
.flash.text 979972 979976 4 0.0
.iram0.text 62016 62016 0 0.0
m5stack (read only) 1035459 1035487 28 0.0
(read/write) 465316 465316 0 0.0
.dram0.bss 68144 68144 0 0.0
.dram0.data 34152 34152 0 0.0
.flash.rodata 231184 231184 0 0.0
.flash.text 1030075 1030103 28 0.0
.iram0.text 123107 123107 0 0.0
k32w light k32w061+release (read/write) 687260 687260 0 0.0
.bss 78128 78128 0 0.0
.data 2036 2036 0 0.0
.text 601296 601296 0 0.0
lock k32w061+release (read/write) 691892 691892 0 0.0
.bss 78704 78704 0 0.0
.data 1996 1996 0 0.0
.text 605392 605392 0 0.0
linux all-clusters-app debug (read only) 2697969 2697841 -128 -0.0
(read/write) 149216 149216 0 0.0
.bss 60192 60192 0 0.0
.data 1888 1888 0 0.0
.data.rel.ro 81080 81080 0 0.0
.dynamic 608 608 0 0.0
.got 4456 4456 0 0.0
.init 27 27 0 0.0
.init_array 984 984 0 0.0
.rodata 232421 232421 0 0.0
.text 2291554 2291426 -128 -0.0
bridge-app debug+rpc (read only) 1837581 1837453 -128 -0.0
(read/write) 91856 91856 0 0.0
.bss 44480 44480 0 0.0
.data 2912 2912 0 0.0
.data.rel.ro 39376 39376 0 0.0
.dynamic 592 592 0 0.0
.got 3936 3936 0 0.0
.init 27 27 0 0.0
.init_array 552 552 0 0.0
.rodata 148505 148505 0 0.0
.text 1570645 1570517 -128 -0.0
chip-tool debug (read only) 10683941 10683829 -112 -0.0
(read/write) 371832 371832 0 0.0
.bss 22752 22752 0 0.0
.data 1104 1104 0 0.0
.data.rel.ro 341728 341728 0 0.0
.dynamic 624 624 0 0.0
.got 4936 4936 0 0.0
.init 27 27 0 0.0
.init_array 656 656 0 0.0
.rodata 538965 538965 0 0.0
.text 9315669 9315557 -112 -0.0
chip-tool-no-interactive-ipv6only arm64 (read only) 10283492 10283348 -144 -0.0
(read/write) 492273 492273 0 0.0
.bss 41025 41025 0 0.0
.data 1168 1168 0 0.0
.data.rel.ro 388840 388840 0 0.0
.dynamic 560 560 0 0.0
.got 57440 57440 0 0.0
.init 24 24 0 0.0
.init_array 184 184 0 0.0
.rodata 513028 513028 0 0.0
.text 8667044 8666900 -144 -0.0
door-lock-app debug (read only) 2108929 2108817 -112 -0.0
(read/write) 119600 119600 0 0.0
.bss 48064 48064 0 0.0
.data 1472 1472 0 0.0
.data.rel.ro 64504 64504 0 0.0
.dynamic 592 592 0 0.0
.got 4264 4264 0 0.0
.init 27 27 0 0.0
.init_array 680 680 0 0.0
.rodata 186697 186697 0 0.0
.text 1766530 1766418 -112 -0.0
lighting-app debug+rpc (read only) 2313769 2313657 -112 -0.0
(read/write) 127920 127920 0 0.0
.bss 50272 50272 0 0.0
.data 1952 1952 0 0.0
.data.rel.ro 69992 69992 0 0.0
.dynamic 608 608 0 0.0
.got 4312 4312 0 0.0
.init 27 27 0 0.0
.init_array 776 776 0 0.0
.rodata 182665 182665 0 0.0
.text 1965266 1965154 -112 -0.0
ota-provider-app debug (read only) 2046145 2046033 -112 -0.0
(read/write) 115040 115040 0 0.0
.bss 47968 47968 0 0.0
.data 1608 1608 0 0.0
.data.rel.ro 59720 59720 0 0.0
.dynamic 608 608 0 0.0
.got 4464 4464 0 0.0
.init 27 27 0 0.0
.init_array 632 632 0 0.0
.rodata 172515 172515 0 0.0
.text 1717442 1717330 -112 -0.0
ota-requestor-app debug (read only) 2076521 2076409 -112 -0.0
(read/write) 118392 118392 0 0.0
.bss 48960 48960 0 0.0
.data 1864 1864 0 0.0
.data.rel.ro 61960 61960 0 0.0
.dynamic 592 592 0 0.0
.got 4304 4304 0 0.0
.init 27 27 0 0.0
.init_array 656 656 0 0.0
.rodata 169388 169388 0 0.0
.text 1749074 1748962 -112 -0.0
shell debug (read only) 2525825 2525713 -112 -0.0
(read/write) 150064 150064 0 0.0
.bss 67624 67624 0 0.0
.data 1264 1264 0 0.0
.data.rel.ro 75464 75464 0 0.0
.dynamic 592 592 0 0.0
.got 4168 4168 0 0.0
.init 27 27 0 0.0
.init_array 928 928 0 0.0
.rodata 214738 214738 0 0.0
.text 2149922 2149810 -112 -0.0
thermostat-no-ble arm64 (read only) 2353620 2353476 -144 -0.0
(read/write) 151121 151121 0 0.0
.bss 63153 63153 0 0.0
.data 1424 1424 0 0.0
.data.rel.ro 78752 78752 0 0.0
.dynamic 560 560 0 0.0
.got 4768 4768 0 0.0
.init 24 24 0 0.0
.init_array 368 368 0 0.0
.rodata 144548 144548 0 0.0
.text 1980496 1980352 -144 -0.0
tv-app debug (read only) 2797265 2797153 -112 -0.0
(read/write) 250784 250784 0 0.0
.bss 164112 164112 0 0.0
.data 4448 4448 0 0.0
.data.rel.ro 76008 76008 0 0.0
.dynamic 592 592 0 0.0
.got 4688 4688 0 0.0
.init 27 27 0 0.0
.init_array 904 904 0 0.0
.rodata 213259 213259 0 0.0
.text 2402706 2402594 -112 -0.0
mbed all-clusters-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2478560 2479456 896 0.0
.bss 191128 191128 0 0.0
.data 5592 5592 0 0.0
.text 1441132 1442028 896 0.1
lighting-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2437080 2437968 888 0.0
.bss 186460 186460 0 0.0
.data 5856 5856 0 0.0
.text 1399652 1400540 888 0.1
lock-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2368516 2369412 896 0.0
.bss 185236 185236 0 0.0
.data 5840 5840 0 0.0
.text 1331116 1332012 896 0.1
pigweed-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 1154596 1154596 0 0.0
.bss 10944 10944 0 0.0
.data 4528 4528 0 0.0
.text 117980 117980 0 0.0
shell CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2363064 2363952 888 0.0
.bss 185016 185016 0 0.0
.data 5624 5624 0 0.0
.text 1325636 1326524 888 0.1
nrfconnect all-clusters-app nrf52840dk_nrf52840 (read/write) 1163459 1163491 32 0.0
bss 136528 136528 0 0.0
rodata 147364 147364 0 0.0
text 800940 800968 28 0.0
lighting-app nrf52840dk_nrf52840 (read/write) 1149615 1149647 32 0.0
bss 140264 140264 0 0.0
rodata 122408 122408 0 0.0
text 808372 808400 28 0.0
nrf52840dk_nrf52840+rpc (read/write) 1113927 1113943 16 0.0
bss 140500 140500 0 0.0
rodata 113520 113520 0 0.0
text 780876 780880 4 0.0
nrf52840dongle_nrf52840 (read/write) 1058111 1058127 16 0.0
bss 147472 147472 0 0.0
rodata 92464 92464 0 0.0
text 737272 737300 28 0.0
nrf5340dk_nrf5340_cpuapp (read/write) 1052074 1052106 32 0.0
bss 136464 136464 0 0.0
rodata 115160 115160 0 0.0
text 718492 718520 28 0.0
lock-app nrf52840dk_nrf52840 (read/write) 1049991 1050023 32 0.0
bss 130208 130208 0 0.0
rodata 115192 115192 0 0.0
text 726120 726148 28 0.0
nrf5340dk_nrf5340_cpuapp (read/write) 952718 952750 32 0.0
bss 126440 126440 0 0.0
rodata 107996 107996 0 0.0
text 636392 636420 28 0.0
pump-app nrf52840dk_nrf52840 (read/write) 1069827 1069859 32 0.0
bss 130216 130216 0 0.0
rodata 117876 117876 0 0.0
text 743112 743140 28 0.0
pump-controller-app nrf52840dk_nrf52840 (read/write) 1051563 1051595 32 0.0
bss 129936 129936 0 0.0
rodata 113884 113884 0 0.0
text 729136 729164 28 0.0
p6 all-clusters-app default (read/write) 2515120 2515120 0 0.0
.bss 118640 118640 0 0.0
.data 2768 2768 0 0.0
.text 1473384 1473384 0 0.0
light-app default (read/write) 2415592 2415592 0 0.0
.bss 112136 112136 0 0.0
.data 2576 2576 0 0.0
.text 1373856 1373856 0 0.0
lock-app default (read/write) 2379160 2379160 0 0.0
.bss 111880 111880 0 0.0
.data 2536 2536 0 0.0
.text 1337424 1337424 0 0.0
telink lighting-app tlsr9518adk80d (read/write) 801516 801524 8 0.0
bss 69988 69988 0 0.0
noinit 40416 40416 0 0.0
text 570132 570136 4 0.0

andrei-menzopol pushed a commit to andrei-menzopol/connectedhomeip that referenced this pull request Apr 14, 2022
* Attempt to skip code in misspell

* Changed a readme.md containing odd words to see if filtering works

* Escape a md file and try to ignore hyperlink content in spellcheck

* More escaping for code in mbedos_commissioning.md

* Add instructions for local spelling run

* More updates to make spell checker happy

* Cleanup some image logic in mbed unit test files

* More updates for spelling - move code blocks into code blocks

* More paths updates for lwip patch readme

* Restyle

* update for allow language in 3 backticks, replaced a lot of mbedos logo pictures

* Code and image block updates on guides

* Updating several nrf files for code blocks

* update k32w android doc for code blocks

* Code blocks for several readmes

* Code blocks for some silabs and esp32

* Code blocks

* More code blocks

* More code blocks

* More code blocks

* More code blocks

* More code blocks

* Roll back some of the wordlist - this takes too long. Just fix some super obvious ones and have some code improvements

* Restyle

* Fix misplaced backtick
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants