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

Better documentation for chip-tool "any" reporting commands. #18717

Merged

Conversation

bzbarsky-apple
Copy link
Contributor

It's not widely known that these commands support multi-path
read/subscribe or how wildcards work.

Problem

People being confused about how to do multi-path reads and the like.

Change overview

Add documentation.

Testing

Ran some read/subscribe commands with invalid args to see the help text.

It's not widely known that these commands support multi-path
read/subscribe or how wildcards work.
@github-actions
Copy link

github-actions bot commented May 22, 2022

PR #18717: Size comparison from b36b8eb to 07b4b13

Increases above 0.2%:

platform target config section b36b8eb 07b4b13 change % change
linux chip-tool debug .rodata 482269 483645 1376 0.3
chip-tool-no-interactive-ipv6only arm64 .rodata 446692 448036 1344 0.3
Increases (2 builds for linux)
platform target config section b36b8eb 07b4b13 change % change
linux chip-tool debug (read only) 9459701 9460549 848 0.0
.rodata 482269 483645 1376 0.3
chip-tool-no-interactive-ipv6only arm64 (read only) 9206580 9207652 1072 0.0
.rodata 446692 448036 1344 0.3
Decreases (2 builds for linux)
platform target config section b36b8eb 07b4b13 change % change
linux chip-tool debug .text 7650501 7649973 -528 -0.0
chip-tool-no-interactive-ipv6only arm64 .text 7297844 7297572 -272 -0.0
Full report (37 builds for cc13x2_26x2, cyw30739, efr32, esp32, k32w, linux, mbed, nrfconnect, p6, telink)
platform target config section b36b8eb 07b4b13 change % change
cc13x2_26x2 all-clusters-app LP_CC2652R7 (read only) 668407 668407 0 0.0
(read/write) 182424 182424 0 0.0
.bss 73812 73812 0 0.0
.data 3404 3404 0 0.0
.rodata 99895 99895 0 0.0
.text 568288 568288 0 0.0
lock-ftd LP_CC2652R7 (read only) 675919 675919 0 0.0
(read/write) 166864 166864 0 0.0
.bss 72820 72820 0 0.0
.data 3236 3236 0 0.0
.rodata 94407 94407 0 0.0
.text 581028 581028 0 0.0
lock-mtd LP_CC2652R7 (read only) 625327 625327 0 0.0
(read/write) 145652 145652 0 0.0
.bss 68556 68556 0 0.0
.data 3236 3236 0 0.0
.rodata 94287 94287 0 0.0
.text 530548 530548 0 0.0
pump-app LP_CC2652R7 (read only) 676003 676003 0 0.0
(read/write) 168084 168084 0 0.0
.bss 73100 73100 0 0.0
.data 3272 3272 0 0.0
.rodata 88899 88899 0 0.0
.text 586620 586620 0 0.0
pump-controller-app LP_CC2652R7 (read only) 653963 653963 0 0.0
(read/write) 189908 189908 0 0.0
.bss 73140 73140 0 0.0
.data 3232 3232 0 0.0
.rodata 83675 83675 0 0.0
.text 569808 569808 0 0.0
shell LP_CC2652R7 (read only) 661494 661494 0 0.0
(read/write) 184896 184896 0 0.0
.bss 76172 76172 0 0.0
.data 3408 3408 0 0.0
.rodata 96862 96862 0 0.0
.text 564404 564404 0 0.0
cyw30739 light cyw930739m2evb_01 (read/write) 624150 624150 0 0.0
.app_xip_area 527508 527508 0 0.0
.bss 79284 79284 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) 626962 626962 0 0.0
.app_xip_area 531776 531776 0 0.0
.bss 77860 77860 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) 570882 570882 0 0.0
.app_xip_area 465980 465980 0 0.0
.bss 87280 87280 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) 915988 915988 0 0.0
(read/write) 133372 133372 0 0.0
.bss 131312 131312 0 0.0
.data 2060 2060 0 0.0
.text 915980 915980 0 0.0
BRD4161A+rpc (read only) 950176 950176 0 0.0
(read/write) 150056 150056 0 0.0
.bss 147792 147792 0 0.0
.data 2264 2264 0 0.0
.text 950168 950168 0 0.0
BRD4161A+rs911x (read only) 790548 790548 0 0.0
(read/write) 129640 129640 0 0.0
.bss 127572 127572 0 0.0
.data 2068 2068 0 0.0
.text 790540 790540 0 0.0
lock-app BRD4161A+wf200 (read only) 946760 946760 0 0.0
(read/write) 124124 124124 0 0.0
.bss 122100 122100 0 0.0
.data 2024 2024 0 0.0
.text 946752 946752 0 0.0
window-app BRD4161A (read only) 897260 897260 0 0.0
(read/write) 133432 133432 0 0.0
.bss 131384 131384 0 0.0
.data 2048 2048 0 0.0
.text 897252 897252 0 0.0
esp32 all-clusters-app c3devkit (read only) 1002770 1002770 0 0.0
(read/write) 1478050 1478050 0 0.0
.dram0.bss 68376 68376 0 0.0
.dram0.data 14624 14624 0 0.0
.flash.rodata 209616 209616 0 0.0
.flash.text 1002770 1002770 0 0.0
.iram0.text 62954 62954 0 0.0
m5stack (read only) 1057595 1057595 0 0.0
(read/write) 480056 480056 0 0.0
.dram0.bss 73896 73896 0 0.0
.dram0.data 34200 34200 0 0.0
.flash.rodata 239964 239964 0 0.0
.flash.text 1052211 1052211 0 0.0
.iram0.text 123267 123267 0 0.0
k32w light k32w061+release (read/write) 682488 682488 0 0.0
.bss 80352 80352 0 0.0
.data 2016 2016 0 0.0
.text 598416 598416 0 0.0
lock k32w061+release (read/write) 728636 728636 0 0.0
.bss 80784 80784 0 0.0
.data 1976 1976 0 0.0
.text 644172 644172 0 0.0
linux all-clusters-app debug (read only) 2759561 2759561 0 0.0
(read/write) 176384 176384 0 0.0
.bss 85440 85440 0 0.0
.data 2064 2064 0 0.0
.data.rel.ro 82712 82712 0 0.0
.dynamic 608 608 0 0.0
.got 4496 4496 0 0.0
.init 27 27 0 0.0
.init_array 1016 1016 0 0.0
.rodata 241373 241373 0 0.0
.text 2343634 2343634 0 0.0
bridge-app debug+rpc (read only) 2035481 2035481 0 0.0
(read/write) 148024 148024 0 0.0
.bss 73120 73120 0 0.0
.data 3936 3936 0 0.0
.data.rel.ro 65384 65384 0 0.0
.dynamic 592 592 0 0.0
.got 4272 4272 0 0.0
.init 27 27 0 0.0
.init_array 688 688 0 0.0
.rodata 169065 169065 0 0.0
.text 1709298 1709298 0 0.0
chip-tool debug (read only) 9459701 9460549 848 0.0
(read/write) 579192 579192 0 0.0
.bss 23936 23936 0 0.0
.data 1152 1152 0 0.0
.data.rel.ro 547800 547800 0 0.0
.dynamic 624 624 0 0.0
.got 5000 5000 0 0.0
.init 27 27 0 0.0
.init_array 656 656 0 0.0
.rodata 482269 483645 1376 0.3
.text 7650501 7649973 -528 -0.0
chip-tool-no-interactive-ipv6only arm64 (read only) 9206580 9207652 1072 0.0
(read/write) 645361 645361 0 0.0
.bss 42225 42225 0 0.0
.data 1192 1192 0 0.0
.data.rel.ro 583112 583112 0 0.0
.dynamic 560 560 0 0.0
.got 14984 14984 0 0.0
.init 24 24 0 0.0
.init_array 184 184 0 0.0
.rodata 446692 448036 1344 0.3
.text 7297844 7297572 -272 -0.0
lighting-app debug+rpc (read only) 2327273 2327273 0 0.0
(read/write) 153440 153440 0 0.0
.bss 74912 74912 0 0.0
.data 2048 2048 0 0.0
.data.rel.ro 70728 70728 0 0.0
.dynamic 608 608 0 0.0
.got 4344 4344 0 0.0
.init 27 27 0 0.0
.init_array 792 792 0 0.0
.rodata 188073 188073 0 0.0
.text 1972850 1972850 0 0.0
lock-app debug (read only) 2240769 2240769 0 0.0
(read/write) 148152 148152 0 0.0
.bss 73600 73600 0 0.0
.data 1568 1568 0 0.0
.data.rel.ro 67272 67272 0 0.0
.dynamic 592 592 0 0.0
.got 4336 4336 0 0.0
.init 27 27 0 0.0
.init_array 752 752 0 0.0
.rodata 198713 198713 0 0.0
.text 1882098 1882098 0 0.0
ota-provider-app debug (read only) 2065977 2065977 0 0.0
(read/write) 141232 141232 0 0.0
.bss 73056 73056 0 0.0
.data 1768 1768 0 0.0
.data.rel.ro 60600 60600 0 0.0
.dynamic 608 608 0 0.0
.got 4504 4504 0 0.0
.init 27 27 0 0.0
.init_array 648 648 0 0.0
.rodata 179872 179872 0 0.0
.text 1727538 1727538 0 0.0
ota-requestor-app debug (read only) 2094929 2094929 0 0.0
(read/write) 144040 144040 0 0.0
.bss 73728 73728 0 0.0
.data 1992 1992 0 0.0
.data.rel.ro 62664 62664 0 0.0
.dynamic 592 592 0 0.0
.got 4344 4344 0 0.0
.init 27 27 0 0.0
.init_array 672 672 0 0.0
.rodata 175840 175840 0 0.0
.text 1759058 1759058 0 0.0
shell debug (read only) 2575769 2575769 0 0.0
(read/write) 200408 200408 0 0.0
.bss 116360 116360 0 0.0
.data 1376 1376 0 0.0
.data.rel.ro 76912 76912 0 0.0
.dynamic 608 608 0 0.0
.got 4192 4192 0 0.0
.init 27 27 0 0.0
.init_array 936 936 0 0.0
.rodata 222354 222354 0 0.0
.text 2192242 2192242 0 0.0
thermostat-no-ble arm64 (read only) 2357292 2357292 0 0.0
(read/write) 176609 176609 0 0.0
.bss 87873 87873 0 0.0
.data 1520 1520 0 0.0
.data.rel.ro 79416 79416 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 147548 147548 0 0.0
.text 1980768 1980768 0 0.0
tv-app debug (read only) 2856913 2856913 0 0.0
(read/write) 279072 279072 0 0.0
.bss 191032 191032 0 0.0
.data 4672 4672 0 0.0
.data.rel.ro 77120 77120 0 0.0
.dynamic 592 592 0 0.0
.got 4720 4720 0 0.0
.init 27 27 0 0.0
.init_array 928 928 0 0.0
.rodata 221137 221137 0 0.0
.text 2453602 2453602 0 0.0
tv-casting-app debug (read only) 5433385 5433385 0 0.0
(read/write) 225344 225344 0 0.0
.bss 78616 78616 0 0.0
.data 2400 2400 0 0.0
.data.rel.ro 138120 138120 0 0.0
.dynamic 608 608 0 0.0
.got 4728 4728 0 0.0
.init 27 27 0 0.0
.init_array 864 864 0 0.0
.rodata 340097 340097 0 0.0
.text 4733794 4733794 0 0.0
mbed lock-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2418936 2418936 0 0.0
.bss 202796 202796 0 0.0
.data 5872 5872 0 0.0
.text 1381580 1381580 0 0.0
nrfconnect all-clusters-app nrf52840dk_nrf52840 (read/write) 1182467 1182467 0 0.0
bss 138540 138540 0 0.0
rodata 152796 152796 0 0.0
text 812288 812288 0 0.0
p6 all-clusters-app default (read/write) 2540656 2540656 0 0.0
.bss 136344 136344 0 0.0
.data 2808 2808 0 0.0
.text 1498920 1498920 0 0.0
light-app default (read/write) 2424552 2424552 0 0.0
.bss 129616 129616 0 0.0
.data 2608 2608 0 0.0
.text 1382816 1382816 0 0.0
lock-app default (read/write) 2435240 2435240 0 0.0
.bss 129432 129432 0 0.0
.data 2568 2568 0 0.0
.text 1393504 1393504 0 0.0
telink light-switch-app tlsr9518adk80d (read/write) 782400 782400 0 0.0
bss 70744 70744 0 0.0
noinit 40416 40416 0 0.0
text 553442 553442 0 0.0
lighting-app tlsr9518adk80d (read/write) 802420 802420 0 0.0
bss 71000 71000 0 0.0
noinit 40416 40416 0 0.0
text 570154 570154 0 0.0

@Damian-Nordic Damian-Nordic merged commit 7674fcf into project-chip:master May 23, 2022
@bzbarsky-apple bzbarsky-apple deleted the better-docs-report-commands branch May 23, 2022 13:52
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