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

[docs] Improve docs on chip-tool tests. Add example. Fix broken links. #18112

Merged
merged 2 commits into from
May 6, 2022

Conversation

turon
Copy link
Contributor

@turon turon commented May 5, 2022

Problem

  • Some links in test suite docs were broken
  • chip-tool tests has no documented example of how to setup and run a 2 node test manually

Testing

Documentation only

@turon turon force-pushed the docs/chip-tool/tests branch from 41c00eb to a632b91 Compare May 5, 2022 17:22
@github-actions
Copy link

github-actions bot commented May 5, 2022

PR #18112: Size comparison from c438b89 to a632b91

Full report (34 builds for cc13x2_26x2, cyw30739, efr32, esp32, k32w, linux, mbed, nrfconnect, p6, telink)
platform target config section c438b89 a632b91 change % change
cc13x2_26x2 all-clusters-app LP_CC2652R7 (read only) 690887 690887 0 0.0
(read/write) 161464 161464 0 0.0
.bss 75332 75332 0 0.0
.data 3412 3412 0 0.0
.rodata 102943 102943 0 0.0
.text 587460 587460 0 0.0
lock-ftd LP_CC2652R7 (read only) 678459 678459 0 0.0
(read/write) 164996 164996 0 0.0
.bss 73492 73492 0 0.0
.data 3236 3236 0 0.0
.rodata 94739 94739 0 0.0
.text 583240 583240 0 0.0
lock-mtd LP_CC2652R7 (read only) 627211 627211 0 0.0
(read/write) 146308 146308 0 0.0
.bss 69212 69212 0 0.0
.data 3236 3236 0 0.0
.rodata 94627 94627 0 0.0
.text 532096 532096 0 0.0
pump-app LP_CC2652R7 (read only) 662983 662983 0 0.0
(read/write) 181768 181768 0 0.0
.bss 73764 73764 0 0.0
.data 3268 3268 0 0.0
.rodata 80935 80935 0 0.0
.text 581564 581564 0 0.0
pump-controller-app LP_CC2652R7 (read only) 655899 655899 0 0.0
(read/write) 188652 188652 0 0.0
.bss 73820 73820 0 0.0
.data 3232 3232 0 0.0
.rodata 83891 83891 0 0.0
.text 571524 571524 0 0.0
cyw30739 light cyw930739m2evb_01 (read/write) 627542 627542 0 0.0
.app_xip_area 530124 530124 0 0.0
.bss 80060 80060 0 0.0
.data 708 708 0 0.0
.rodata 0 0 0 0.0
.text 0 0 0 0.0
lock cyw930739m2evb_01 (read/write) 626446 626446 0 0.0
.app_xip_area 530492 530492 0 0.0
.bss 78628 78628 0 0.0
.data 672 672 0 0.0
.rodata 0 0 0 0.0
.text 0 0 0 0.0
ota-requestor-no-progress-logging cyw930739m2evb_01 (read/write) 575182 575182 0 0.0
.app_xip_area 469512 469512 0 0.0
.bss 88048 88048 0 0.0
.data 584 584 0 0.0
.rodata 0 0 0 0.0
.text 112 112 0 0.0
efr32 lighting-app BRD4161A (read only) 910044 910044 0 0.0
(read/write) 134520 134520 0 0.0
.bss 132456 132456 0 0.0
.data 2064 2064 0 0.0
.text 910036 910036 0 0.0
BRD4161A+rpc (read only) 944404 944404 0 0.0
(read/write) 151204 151204 0 0.0
.bss 148936 148936 0 0.0
.data 2268 2268 0 0.0
.text 944396 944396 0 0.0
BRD4161A+rs911x (read only) 787276 787276 0 0.0
(read/write) 129776 129776 0 0.0
.bss 127708 127708 0 0.0
.data 2068 2068 0 0.0
.text 787268 787268 0 0.0
lock-app BRD4161A+wf200 (read only) 946392 946392 0 0.0
(read/write) 124268 124268 0 0.0
.bss 122244 122244 0 0.0
.data 2024 2024 0 0.0
.text 946384 946384 0 0.0
window-app BRD4161A (read only) 886464 886464 0 0.0
(read/write) 134472 134472 0 0.0
.bss 132416 132416 0 0.0
.data 2052 2052 0 0.0
.text 886456 886456 0 0.0
esp32 all-clusters-app c3devkit (read only) 1001004 1001004 0 0.0
(read/write) 1475322 1475322 0 0.0
.dram0.bss 68472 68472 0 0.0
.dram0.data 14444 14444 0 0.0
.flash.rodata 207952 207952 0 0.0
.flash.text 1001004 1001004 0 0.0
.iram0.text 62020 62020 0 0.0
m5stack (read only) 1056027 1056027 0 0.0
(read/write) 477736 477736 0 0.0
.dram0.bss 73984 73984 0 0.0
.dram0.data 34184 34184 0 0.0
.flash.rodata 237732 237732 0 0.0
.flash.text 1050643 1050643 0 0.0
.iram0.text 123107 123107 0 0.0
k32w light k32w061+release (read/write) 685092 685092 0 0.0
.bss 81256 81256 0 0.0
.data 2020 2020 0 0.0
.text 600112 600112 0 0.0
lock k32w061+release (read/write) 730432 730432 0 0.0
.bss 81688 81688 0 0.0
.data 1980 1980 0 0.0
.text 645060 645060 0 0.0
linux all-clusters-app debug (read only) 2739385 2739385 0 0.0
(read/write) 174200 174200 0 0.0
.bss 83680 83680 0 0.0
.data 2064 2064 0 0.0
.data.rel.ro 82328 82328 0 0.0
.dynamic 608 608 0 0.0
.got 4464 4464 0 0.0
.init 27 27 0 0.0
.init_array 1008 1008 0 0.0
.rodata 236005 236005 0 0.0
.text 2328370 2328370 0 0.0
bridge-app debug+rpc (read only) 1893489 1893489 0 0.0
(read/write) 120920 120920 0 0.0
.bss 71520 71520 0 0.0
.data 3488 3488 0 0.0
.data.rel.ro 40584 40584 0 0.0
.dynamic 592 592 0 0.0
.got 4032 4032 0 0.0
.init 27 27 0 0.0
.init_array 688 688 0 0.0
.rodata 161241 161241 0 0.0
.text 1609586 1609586 0 0.0
chip-tool debug (read only) 8981213 8981213 0 0.0
(read/write) 576880 576880 0 0.0
.bss 22816 22816 0 0.0
.data 1136 1136 0 0.0
.data.rel.ro 546656 546656 0 0.0
.dynamic 624 624 0 0.0
.got 4952 4952 0 0.0
.init 27 27 0 0.0
.init_array 648 648 0 0.0
.rodata 464213 464213 0 0.0
.text 7193397 7193397 0 0.0
chip-tool-no-interactive-ipv6only arm64 (read only) 8820548 8820548 0 0.0
(read/write) 643057 643057 0 0.0
.bss 41105 41105 0 0.0
.data 1192 1192 0 0.0
.data.rel.ro 581976 581976 0 0.0
.dynamic 560 560 0 0.0
.got 14968 14968 0 0.0
.init 24 24 0 0.0
.init_array 184 184 0 0.0
.rodata 431780 431780 0 0.0
.text 6929700 6929700 0 0.0
lighting-app debug+rpc (read only) 2327601 2327601 0 0.0
(read/write) 151872 151872 0 0.0
.bss 73568 73568 0 0.0
.data 2048 2048 0 0.0
.data.rel.ro 70504 70504 0 0.0
.dynamic 608 608 0 0.0
.got 4320 4320 0 0.0
.init 27 27 0 0.0
.init_array 792 792 0 0.0
.rodata 185401 185401 0 0.0
.text 1975682 1975682 0 0.0
lock-app debug (read only) 2234897 2234897 0 0.0
(read/write) 146456 146456 0 0.0
.bss 72192 72192 0 0.0
.data 1568 1568 0 0.0
.data.rel.ro 67032 67032 0 0.0
.dynamic 592 592 0 0.0
.got 4312 4312 0 0.0
.init 27 27 0 0.0
.init_array 752 752 0 0.0
.rodata 195145 195145 0 0.0
.text 1879586 1879586 0 0.0
ota-provider-app debug (read only) 2063225 2063225 0 0.0
(read/write) 139568 139568 0 0.0
.bss 71680 71680 0 0.0
.data 1736 1736 0 0.0
.data.rel.ro 60376 60376 0 0.0
.dynamic 608 608 0 0.0
.got 4480 4480 0 0.0
.init 27 27 0 0.0
.init_array 648 648 0 0.0
.rodata 176147 176147 0 0.0
.text 1729378 1729378 0 0.0
ota-requestor-app debug (read only) 2094353 2094353 0 0.0
(read/write) 142376 142376 0 0.0
.bss 72320 72320 0 0.0
.data 1992 1992 0 0.0
.data.rel.ro 62440 62440 0 0.0
.dynamic 592 592 0 0.0
.got 4320 4320 0 0.0
.init 27 27 0 0.0
.init_array 672 672 0 0.0
.rodata 172444 172444 0 0.0
.text 1762722 1762722 0 0.0
shell debug (read only) 2564361 2564361 0 0.0
(read/write) 198096 198096 0 0.0
.bss 114408 114408 0 0.0
.data 1376 1376 0 0.0
.data.rel.ro 76600 76600 0 0.0
.dynamic 592 592 0 0.0
.got 4184 4184 0 0.0
.init 27 27 0 0.0
.init_array 928 928 0 0.0
.rodata 217458 217458 0 0.0
.text 2184994 2184994 0 0.0
thermostat-no-ble arm64 (read only) 2367980 2367980 0 0.0
(read/write) 175057 175057 0 0.0
.bss 86417 86417 0 0.0
.data 1520 1520 0 0.0
.data.rel.ro 79312 79312 0 0.0
.dynamic 560 560 0 0.0
.got 4768 4768 0 0.0
.init 24 24 0 0.0
.init_array 376 376 0 0.0
.rodata 146524 146524 0 0.0
.text 1991904 1991904 0 0.0
tv-app debug (read only) 2850137 2850137 0 0.0
(read/write) 277152 277152 0 0.0
.bss 189464 189464 0 0.0
.data 4672 4672 0 0.0
.data.rel.ro 76792 76792 0 0.0
.dynamic 592 592 0 0.0
.got 4696 4696 0 0.0
.init 27 27 0 0.0
.init_array 928 928 0 0.0
.rodata 218059 218059 0 0.0
.text 2449618 2449618 0 0.0
mbed lock-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2419676 2419676 0 0.0
.bss 205828 205828 0 0.0
.data 5872 5872 0 0.0
.text 1382276 1382276 0 0.0
nrfconnect all-clusters-app nrf52840dk_nrf52840 (read/write) 1179727 1179727 0 0.0
bss 139684 139684 0 0.0
rodata 151504 151504 0 0.0
text 809836 809836 0 0.0
p6 all-clusters-app default (read/write) 2531120 2531120 0 0.0
.bss 139336 139336 0 0.0
.data 2808 2808 0 0.0
.text 1489384 1489384 0 0.0
light-app default (read/write) 2421176 2421176 0 0.0
.bss 132656 132656 0 0.0
.data 2608 2608 0 0.0
.text 1379440 1379440 0 0.0
lock-app default (read/write) 2430680 2430680 0 0.0
.bss 132480 132480 0 0.0
.data 2568 2568 0 0.0
.text 1388944 1388944 0 0.0
telink lighting-app tlsr9518adk80d (read/write) 805980 805980 0 0.0
bss 72180 72180 0 0.0
noinit 40416 40416 0 0.0
text 572406 572406 0 0.0

@andy31415 andy31415 merged commit 96f31bc into project-chip:master May 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
app documentation Improvements or additions to documentation review - approved
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants