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

Fix documentation to align with code. #15872

Merged
merged 1 commit into from
Mar 4, 2022

Conversation

bzbarsky-apple
Copy link
Contributor

Problem

Javadoc comments that don't match the code, triggering build warnings.

Change overview

  • Fix the comments.
  • Enable checking for this in CI, since it looks like we now have all such broken comments fixed.
  • Enable checking for a few other warnings in CI now that we are not triggering them.

Testing

Should have no behavior changes.

@github-actions
Copy link

github-actions bot commented Mar 4, 2022

PR #15872: Size comparison from 8e8f419 to 19023f4

Full report (22 builds for cyw30739, efr32, esp32, k32w, linux, mbed, nrfconnect, p6, qpg, telink)
platform target config section 8e8f419 19023f4 change % change
cyw30739 light cyw930739m2evb_01 (read/write) 600686 600686 0 0.0
.app_xip_area 505644 505644 0 0.0
.bss 77724 77724 0 0.0
.data 660 660 0 0.0
.rodata 0 0 0 0.0
.text 0 0 0 0.0
lock cyw930739m2evb_01 (read/write) 558682 558682 0 0.0
.app_xip_area 465176 465176 0 0.0
.bss 76228 76228 0 0.0
.data 624 624 0 0.0
.rodata 0 0 0 0.0
.text 0 0 0 0.0
ota-requestor cyw930739m2evb_01 (read/write) 580626 580626 0 0.0
.app_xip_area 477448 477448 0 0.0
.bss 85548 85548 0 0.0
.data 592 592 0 0.0
.rodata 0 0 0 0.0
.text 112 112 0 0.0
efr32 lighting-app BRD4161A (read only) 919836 919836 0 0.0
(read/write) 128824 128824 0 0.0
.bss 126744 126744 0 0.0
.data 2080 2080 0 0.0
.text 919828 919828 0 0.0
BRD4161A+rpc (read only) 948640 948640 0 0.0
(read/write) 144784 144784 0 0.0
.bss 142520 142520 0 0.0
.data 2260 2260 0 0.0
.text 948632 948632 0 0.0
lock-app BRD4161A+wf200 (read only) 988220 988220 0 0.0
(read/write) 120352 120352 0 0.0
.bss 118420 118420 0 0.0
.data 1932 1932 0 0.0
.text 988212 988212 0 0.0
window-app BRD4161A (read only) 853216 853216 0 0.0
(read/write) 126824 126824 0 0.0
.bss 124896 124896 0 0.0
.data 1924 1924 0 0.0
.text 853208 853208 0 0.0
esp32 all-clusters-app c3devkit (read only) 954852 954852 0 0.0
(read/write) 1392738 1392738 0 0.0
.dram0.bss 62584 62584 0 0.0
.dram0.data 14236 14236 0 0.0
.flash.rodata 197000 197000 0 0.0
.flash.text 954852 954852 0 0.0
.iram0.text 62016 62016 0 0.0
m5stack (read only) 1009879 1009879 0 0.0
(read/write) 459836 459836 0 0.0
.dram0.bss 68104 68104 0 0.0
.dram0.data 34080 34080 0 0.0
.flash.rodata 225816 225816 0 0.0
.flash.text 1004495 1004495 0 0.0
.iram0.text 123107 123107 0 0.0
k32w light k32w061+release (read/write) 694032 694032 0 0.0
.bss 77680 77680 0 0.0
.data 1964 1964 0 0.0
.text 608588 608588 0 0.0
lock k32w061+release (read/write) 695880 695880 0 0.0
.bss 77656 77656 0 0.0
.data 1972 1972 0 0.0
.text 610452 610452 0 0.0
linux chip-tool-ipv6only arm64 (read only) 9101748 9101748 0 0.0
(read/write) 418673 418673 0 0.0
.bss 43841 43841 0 0.0
.data 1192 1192 0 0.0
.data.rel.ro 317984 317984 0 0.0
.dynamic 560 560 0 0.0
.got 51856 51856 0 0.0
.init 24 24 0 0.0
.init_array 192 192 0 0.0
.rodata 473660 473660 0 0.0
.text 7710164 7710164 0 0.0
thermostat-no-ble arm64 (read only) 2172180 2172180 0 0.0
(read/write) 148497 148497 0 0.0
.bss 65185 65185 0 0.0
.data 1072 1072 0 0.0
.data.rel.ro 75048 75048 0 0.0
.dynamic 560 560 0 0.0
.got 4216 4216 0 0.0
.init 24 24 0 0.0
.init_array 352 352 0 0.0
.rodata 132964 132964 0 0.0
.text 1820784 1820784 0 0.0
mbed lock-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2350196 2350196 0 0.0
.bss 186068 186068 0 0.0
.data 5800 5800 0 0.0
.text 1312796 1312796 0 0.0
nrfconnect all-clusters-app nrf52840dk_nrf52840 (read/write) 1148443 1148443 0 0.0
bss 145932 145932 0 0.0
rodata 144244 144244 0 0.0
text 782976 782976 0 0.0
p6 all-clusters-app default (read/write) 2490400 2490400 0 0.0
.bss 118656 118656 0 0.0
.data 2696 2696 0 0.0
.text 1448664 1448664 0 0.0
light-app default (read/write) 2396808 2396808 0 0.0
.bss 112960 112960 0 0.0
.data 2544 2544 0 0.0
.text 1355072 1355072 0 0.0
lock-app default (read/write) 2360320 2360320 0 0.0
.bss 112704 112704 0 0.0
.data 2504 2504 0 0.0
.text 1318584 1318584 0 0.0
qpg lighting-app qpg6105+debug (read only) 603208 603208 0 0.0
(read/write) 146936 146936 0 0.0
.bss 91056 91056 0 0.0
.data 1164 1164 0 0.0
.text 597888 597888 0 0.0
lock-app qpg6105+debug (read only) 568892 568892 0 0.0
(read/write) 146936 146936 0 0.0
.bss 91064 91064 0 0.0
.data 1116 1116 0 0.0
.text 563572 563572 0 0.0
persistent-storage-app qpg6105+debug (read only) 99520 99520 0 0.0
(read/write) 146940 146940 0 0.0
.bss 24004 24004 0 0.0
.data 176 176 0 0.0
.text 94200 94200 0 0.0
telink lighting-app tlsr9518adk80d (read/write) 888290 888290 0 0.0
bss 86912 86912 0 0.0
noinit 37160 37160 0 0.0
text 627698 627698 0 0.0

@woody-apple woody-apple merged commit a9741c6 into project-chip:master Mar 4, 2022
@bzbarsky-apple bzbarsky-apple deleted the fix-build-warnings branch March 4, 2022 18:57
woody-apple added a commit that referenced this pull request Mar 4, 2022
woody-apple added a commit that referenced this pull request Mar 4, 2022
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.

4 participants