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: fix title and add link for building guide #19250

Merged
merged 1 commit into from
Jun 8, 2022

Conversation

presto8
Copy link
Contributor

@presto8 presto8 commented Jun 6, 2022

Problem

What is being fixed? Examples:

  • Documentation

Change overview

Documentation has slightly incorrect reference to another section. On the first read, I didn't understand that it was referring to the previous section of the docs. Added an intradocument link to make it easier on the user.

Testing

  • Tested by pushing to my fork and verifying that it looks good and the link works.

@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Jun 6, 2022
@CLAassistant
Copy link

CLAassistant commented Jun 6, 2022

CLA assistant check
All committers have signed the CLA.

@bzbarsky-apple
Copy link
Contributor

@presto8 Needs restyled updates.

@presto8
Copy link
Contributor Author

presto8 commented Jun 8, 2022

Thanks @bzbarsky-apple: I will do that as soon as I figure out how to use this workflow :)

@github-actions
Copy link

github-actions bot commented Jun 8, 2022

PR #19250: Size comparison from c8fa512 to bebaa8c

Increases (4 builds for cc13x2_26x2, nrfconnect, telink)
platform target config section c8fa512 bebaa8c change % change
cc13x2_26x2 pump-controller-app LP_CC2652R7 (read/write) 188444 188452 8 0.0
nrfconnect all-clusters-app nrf52840dk_nrf52840 text 817072 817076 4 0.0
telink light-switch-app tlsr9518adk80d text 552550 552552 2 0.0
lighting-app tlsr9518adk80d text 569268 569270 2 0.0
Decreases (1 build for cc13x2_26x2)
platform target config section c8fa512 bebaa8c change % change
cc13x2_26x2 pump-controller-app LP_CC2652R7 (read only) 655403 655395 -8 -0.0
.text 570708 570700 -8 -0.0
Full report (39 builds for cc13x2_26x2, cyw30739, efr32, k32w, linux, mbed, nrfconnect, p6, telink)
platform target config section c8fa512 bebaa8c change % change
cc13x2_26x2 all-clusters-app LP_CC2652R7 (read only) 689863 689863 0 0.0
(read/write) 161904 161904 0 0.0
.bss 74660 74660 0 0.0
.data 3392 3392 0 0.0
.rodata 112279 112279 0 0.0
.text 577272 577272 0 0.0
all-clusters-minimal-app LP_CC2652R7 (read only) 640479 640479 0 0.0
(read/write) 158132 158132 0 0.0
.bss 73884 73884 0 0.0
.data 3332 3332 0 0.0
.rodata 89319 89319 0 0.0
.text 550840 550840 0 0.0
lock-ftd LP_CC2652R7 (read only) 683375 683375 0 0.0
(read/write) 159456 159456 0 0.0
.bss 72612 72612 0 0.0
.data 3256 3256 0 0.0
.rodata 98143 98143 0 0.0
.text 584748 584748 0 0.0
lock-mtd LP_CC2652R7 (read only) 632791 632791 0 0.0
(read/write) 145720 145720 0 0.0
.bss 68348 68348 0 0.0
.data 3256 3256 0 0.0
.rodata 98031 98031 0 0.0
.text 534268 534268 0 0.0
pump-app LP_CC2652R7 (read only) 664819 664819 0 0.0
(read/write) 178924 178924 0 0.0
.bss 72756 72756 0 0.0
.data 3292 3292 0 0.0
.rodata 86315 86315 0 0.0
.text 578020 578020 0 0.0
pump-controller-app LP_CC2652R7 (read only) 655403 655395 -8 -0.0
(read/write) 188444 188452 8 0.0
.bss 72860 72860 0 0.0
.data 3252 3252 0 0.0
.rodata 84211 84211 0 0.0
.text 570708 570700 -8 -0.0
shell LP_CC2652R7 (read only) 682142 682142 0 0.0
(read/write) 165120 165120 0 0.0
.bss 76956 76956 0 0.0
.data 3396 3396 0 0.0
.rodata 108878 108878 0 0.0
.text 572952 572952 0 0.0
cyw30739 light cyw930739m2evb_01 (read/write) 602546 602546 0 0.0
.app_xip_area 461492 461492 0 0.0
.bss 84008 84008 0 0.0
.data 732 732 0 0.0
.rodata 0 0 0 0.0
.text 112 112 0 0.0
lock cyw930739m2evb_01 (read/write) 599630 599630 0 0.0
.app_xip_area 458440 458440 0 0.0
.bss 84176 84176 0 0.0
.data 700 700 0 0.0
.rodata 0 0 0 0.0
.text 112 112 0 0.0
ota-requestor-no-progress-logging cyw930739m2evb_01 (read/write) 599374 599374 0 0.0
.app_xip_area 459300 459300 0 0.0
.bss 83140 83140 0 0.0
.data 616 616 0 0.0
.rodata 0 0 0 0.0
.text 112 112 0 0.0
efr32 lighting-app BRD4161A (read only) 914968 914968 0 0.0
(read/write) 133176 133176 0 0.0
.bss 131088 131088 0 0.0
.data 2088 2088 0 0.0
.text 914960 914960 0 0.0
BRD4161A+rpc (read only) 949188 949188 0 0.0
(read/write) 149868 149868 0 0.0
.bss 147576 147576 0 0.0
.data 2292 2292 0 0.0
.text 949180 949180 0 0.0
BRD4161A+rs911x (read only) 790156 790156 0 0.0
(read/write) 129460 129460 0 0.0
.bss 127364 127364 0 0.0
.data 2096 2096 0 0.0
.text 790148 790148 0 0.0
lock-app BRD4161A+wf200 (read only) 958396 958396 0 0.0
(read/write) 128252 128252 0 0.0
.bss 126188 126188 0 0.0
.data 2064 2064 0 0.0
.text 958388 958388 0 0.0
window-app BRD4161A (read only) 900040 900040 0 0.0
(read/write) 133264 133264 0 0.0
.bss 131176 131176 0 0.0
.data 2084 2084 0 0.0
.text 900032 900032 0 0.0
k32w light k32w061+release (read/write) 653744 653744 0 0.0
.bss 70044 70044 0 0.0
.data 2004 2004 0 0.0
.text 575896 575896 0 0.0
lock k32w061+release (read/write) 714788 714788 0 0.0
.bss 70484 70484 0 0.0
.data 1976 1976 0 0.0
.text 636528 636528 0 0.0
linux all-clusters-app debug (read only) 2892297 2892297 0 0.0
(read/write) 180024 180024 0 0.0
.bss 87840 87840 0 0.0
.data 2016 2016 0 0.0
.data.rel.ro 83960 83960 0 0.0
.dynamic 608 608 0 0.0
.got 4544 4544 0 0.0
.init 27 27 0 0.0
.init_array 1040 1040 0 0.0
.rodata 255421 255421 0 0.0
.text 2462354 2462354 0 0.0
all-clusters-minimal-app debug (read only) 2753809 2753809 0 0.0
(read/write) 171640 171640 0 0.0
.bss 87008 87008 0 0.0
.data 1888 1888 0 0.0
.data.rel.ro 76584 76584 0 0.0
.dynamic 608 608 0 0.0
.got 4496 4496 0 0.0
.init 27 27 0 0.0
.init_array 1040 1040 0 0.0
.rodata 256733 256733 0 0.0
.text 2324562 2324562 0 0.0
bridge-app debug+rpc (read only) 2197825 2197825 0 0.0
(read/write) 149528 149528 0 0.0
.bss 74496 74496 0 0.0
.data 3888 3888 0 0.0
.data.rel.ro 65400 65400 0 0.0
.dynamic 608 608 0 0.0
.got 4392 4392 0 0.0
.init 27 27 0 0.0
.init_array 720 720 0 0.0
.rodata 187776 187776 0 0.0
.text 1851138 1851138 0 0.0
chip-tool debug (read only) 9736869 9736869 0 0.0
(read/write) 608032 608032 0 0.0
.bss 25408 25408 0 0.0
.data 1088 1088 0 0.0
.data.rel.ro 575240 575240 0 0.0
.dynamic 624 624 0 0.0
.got 5000 5000 0 0.0
.init 27 27 0 0.0
.init_array 664 664 0 0.0
.rodata 505373 505373 0 0.0
.text 7829493 7829493 0 0.0
chip-tool-no-interactive-ipv6only arm64 (read only) 9474604 9474604 0 0.0
(read/write) 674257 674257 0 0.0
.bss 43681 43681 0 0.0
.data 1152 1152 0 0.0
.data.rel.ro 610696 610696 0 0.0
.dynamic 528 528 0 0.0
.got 14928 14928 0 0.0
.init 24 24 0 0.0
.init_array 192 192 0 0.0
.rodata 467548 467548 0 0.0
.text 7470052 7470052 0 0.0
lighting-app debug+rpc (read only) 2482257 2482257 0 0.0
(read/write) 155136 155136 0 0.0
.bss 76320 76320 0 0.0
.data 2032 2032 0 0.0
.data.rel.ro 70888 70888 0 0.0
.dynamic 608 608 0 0.0
.got 4432 4432 0 0.0
.init 27 27 0 0.0
.init_array 824 824 0 0.0
.rodata 205352 205352 0 0.0
.text 2109314 2109314 0 0.0
lock-app debug (read only) 2428193 2428193 0 0.0
(read/write) 150272 150272 0 0.0
.bss 75040 75040 0 0.0
.data 1520 1520 0 0.0
.data.rel.ro 67848 67848 0 0.0
.dynamic 608 608 0 0.0
.got 4432 4432 0 0.0
.init 27 27 0 0.0
.init_array 792 792 0 0.0
.rodata 219368 219368 0 0.0
.text 2046226 2046226 0 0.0
ota-provider-app debug (read only) 2203625 2203625 0 0.0
(read/write) 143264 143264 0 0.0
.bss 74496 74496 0 0.0
.data 1752 1752 0 0.0
.data.rel.ro 61208 61208 0 0.0
.dynamic 608 608 0 0.0
.got 4496 4496 0 0.0
.init 27 27 0 0.0
.init_array 664 664 0 0.0
.rodata 191896 191896 0 0.0
.text 1852050 1852050 0 0.0
ota-requestor-app debug (read only) 2265289 2265289 0 0.0
(read/write) 146312 146312 0 0.0
.bss 75264 75264 0 0.0
.data 1944 1944 0 0.0
.data.rel.ro 63320 63320 0 0.0
.dynamic 608 608 0 0.0
.got 4456 4456 0 0.0
.init 27 27 0 0.0
.init_array 704 704 0 0.0
.rodata 195264 195264 0 0.0
.text 1906290 1906290 0 0.0
shell debug (read only) 2583953 2583953 0 0.0
(read/write) 203200 203200 0 0.0
.bss 118728 118728 0 0.0
.data 1328 1328 0 0.0
.data.rel.ro 77392 77392 0 0.0
.dynamic 608 608 0 0.0
.got 4176 4176 0 0.0
.init 27 27 0 0.0
.init_array 944 944 0 0.0
.rodata 228018 228018 0 0.0
.text 2197314 2197314 0 0.0
thermostat-no-ble arm64 (read only) 2543900 2543900 0 0.0
(read/write) 183073 183073 0 0.0
.bss 91409 91409 0 0.0
.data 1512 1512 0 0.0
.data.rel.ro 82144 82144 0 0.0
.dynamic 528 528 0 0.0
.got 4992 4992 0 0.0
.init 24 24 0 0.0
.init_array 400 400 0 0.0
.rodata 160084 160084 0 0.0
.text 2146880 2146880 0 0.0
tv-app debug (read only) 3030313 3030313 0 0.0
(read/write) 281904 281904 0 0.0
.bss 192616 192616 0 0.0
.data 4656 4656 0 0.0
.data.rel.ro 78184 78184 0 0.0
.dynamic 608 608 0 0.0
.got 4848 4848 0 0.0
.init 27 27 0 0.0
.init_array 960 960 0 0.0
.rodata 240608 240608 0 0.0
.text 2604642 2604642 0 0.0
tv-casting-app debug (read only) 5333921 5333921 0 0.0
(read/write) 223968 223968 0 0.0
.bss 80136 80136 0 0.0
.data 2416 2416 0 0.0
.data.rel.ro 135168 135168 0 0.0
.dynamic 608 608 0 0.0
.got 4712 4712 0 0.0
.init 27 27 0 0.0
.init_array 880 880 0 0.0
.rodata 340448 340448 0 0.0
.text 4642994 4642994 0 0.0
mbed lock-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2429544 2429544 0 0.0
.bss 202692 202692 0 0.0
.data 5872 5872 0 0.0
.text 1392188 1392188 0 0.0
nrfconnect all-clusters-app nrf52840dk_nrf52840 (read/write) 1191959 1191959 0 0.0
bss 141362 141362 0 0.0
rodata 154600 154600 0 0.0
text 817072 817076 4 0.0
all-clusters-minimal-app nrf52840dk_nrf52840 (read/write) 1139683 1139683 0 0.0
bss 140579 140579 0 0.0
rodata 131092 131092 0 0.0
text 789128 789128 0 0.0
p6 all-clusters-app default (read/write) 2544464 2544464 0 0.0
.bss 137120 137120 0 0.0
.data 2808 2808 0 0.0
.text 1502728 1502728 0 0.0
all-clusters-minimal-app default (read/write) 2489328 2489328 0 0.0
.bss 136328 136328 0 0.0
.data 2752 2752 0 0.0
.text 1447592 1447592 0 0.0
light-app default (read/write) 2421240 2421240 0 0.0
.bss 129432 129432 0 0.0
.data 2600 2600 0 0.0
.text 1379504 1379504 0 0.0
lock-app default (read/write) 2441576 2441576 0 0.0
.bss 129256 129256 0 0.0
.data 2576 2576 0 0.0
.text 1399840 1399840 0 0.0
telink light-switch-app tlsr9518adk80d (read/write) 781628 781628 0 0.0
bss 70636 70636 0 0.0
noinit 40416 40416 0 0.0
text 552550 552552 2 0.0
lighting-app tlsr9518adk80d (read/write) 801640 801640 0 0.0
bss 70888 70888 0 0.0
noinit 40416 40416 0 0.0
text 569268 569270 2 0.0

@andy31415 andy31415 merged commit 3bec7f6 into project-chip:master Jun 8, 2022
mkardous-silabs pushed a commit to mkardous-silabs/connectedhomeip that referenced this pull request Jun 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation review - approved
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants