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

SDK tutorial: turn into MD file #31409

Merged
merged 17 commits into from
Jan 17, 2024
Merged

Conversation

cecille
Copy link
Contributor

@cecille cecille commented Jan 15, 2024

This will allow us to update without going through causeway.

This will allow us to update without going through causeway.
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 15, 2024
Copy link

github-actions bot commented Jan 15, 2024

PR #31409: Size comparison from 4676d27 to e3c30c1

Full report (68 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, esp32, k32w, linux, mbed, nrfconnect, psoc6, qpg, telink)
platform target config section 4676d27 e3c30c1 change % change
bl602 lighting-app bl602 (read/write) 1420086 1420086 0 0.0
.bss 85184 85184 0 0.0
.data 9488 9488 0 0.0
.rodata 157048 157048 0 0.0
.text 1087726 1087726 0 0.0
bl602+mfd (read/write) 1434558 1434558 0 0.0
.bss 85352 85352 0 0.0
.data 9456 9456 0 0.0
.rodata 156008 156008 0 0.0
.text 1103094 1103094 0 0.0
bl602+rpc (read/write) 1467862 1467862 0 0.0
.bss 93216 93216 0 0.0
.data 9856 9856 0 0.0
.rodata 164664 164664 0 0.0
.text 1119470 1119470 0 0.0
bl702 lighting-app bl702 (read only) 3478 3478 0 0.0
(read/write) 1185131 1185131 0 0.0
.bss 11133 11133 0 0.0
.data 3656 3656 0 0.0
.rodata 106420 106420 0 0.0
.text 957390 957390 0 0.0
bl702+mfd (read only) 3478 3478 0 0.0
(read/write) 1196263 1196263 0 0.0
.bss 11309 11309 0 0.0
.data 3640 3640 0 0.0
.rodata 105360 105360 0 0.0
.text 969454 969454 0 0.0
bl702+rpc (read only) 3478 3478 0 0.0
(read/write) 1276807 1276807 0 0.0
.bss 19597 19597 0 0.0
.data 4216 4216 0 0.0
.rodata 121840 121840 0 0.0
.text 1032196 1032196 0 0.0
bl706-eth (read/write) 1004249 1004249 0 0.0
.bss 23692 23692 0 0.0
.data 3232 3232 0 0.0
.rodata 99752 99752 0 0.0
.text 749796 749796 0 0.0
bl706-wifi (read/write) 1235138 1235138 0 0.0
.bss 10577 10577 0 0.0
.data 3672 3672 0 0.0
.rodata 120732 120732 0 0.0
.text 977928 977928 0 0.0
bl702l lighting-app bl702l (read/write) 1155284 1155284 0 0.0
.bss 16328 16328 0 0.0
.data 5024 5024 0 0.0
.rodata 100424 100424 0 0.0
.text 950516 950516 0 0.0
bl702l+mfd (read only) 512 512 0 0.0
(read/write) 1165968 1165968 0 0.0
.bss 16504 16504 0 0.0
.data 5000 5000 0 0.0
.rodata 99364 99364 0 0.0
.text 962636 962636 0 0.0
cc13x4_26x4 lighting-app LP_EM_CC1354P10_6 (read only) 778248 778248 0 0.0
(read/write) 168380 168380 0 0.0
.bss 90452 90452 0 0.0
.data 3524 3524 0 0.0
.rodata 88896 88896 0 0.0
.text 689088 689088 0 0.0
lock-ftd LP_EM_CC1354P10_6 (read only) 794264 794264 0 0.0
(read/write) 178608 178608 0 0.0
.bss 100628 100628 0 0.0
.data 3552 3552 0 0.0
.rodata 83112 83112 0 0.0
.text 710884 710884 0 0.0
lock-mtd LP_EM_CC1354P10_6 (read only) 782568 782568 0 0.0
(read/write) 173064 173064 0 0.0
.bss 95084 95084 0 0.0
.data 3552 3552 0 0.0
.rodata 109760 109760 0 0.0
.text 672540 672540 0 0.0
pump-app LP_EM_CC1354P10_6 (read only) 735192 735192 0 0.0
(read/write) 167384 167384 0 0.0
.bss 89232 89232 0 0.0
.data 3512 3512 0 0.0
.rodata 84488 84488 0 0.0
.text 650440 650440 0 0.0
pump-controller-app LP_EM_CC1354P10_6 (read only) 720704 720704 0 0.0
(read/write) 167564 167564 0 0.0
.bss 89416 89416 0 0.0
.data 3508 3508 0 0.0
.rodata 80328 80328 0 0.0
.text 640112 640112 0 0.0
cc32xx air-purifier CC3235SF_LAUNCHXL (read only) 568106 568106 0 0.0
(read/write) 207744 207744 0 0.0
.bss 201028 201028 0 0.0
.data 1592 1592 0 0.0
.rodata 84034 84034 0 0.0
.text 481948 481948 0 0.0
lock CC3235SF_LAUNCHXL (read only) 621458 621458 0 0.0
(read/write) 208144 208144 0 0.0
.bss 201504 201504 0 0.0
.data 1520 1520 0 0.0
.rodata 105898 105898 0 0.0
.text 513436 513436 0 0.0
cyw30739 light cyw930739m2evb_01 (read/write) 562271 562271 0 0.0
.app_xip_area 452425 452425 0 0.0
.bss 64688 64688 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) 544527 544527 0 0.0
.app_xip_area 429945 429945 0 0.0
.bss 69384 69384 0 0.0
.data 772 772 0 0.0
.rodata 0 0 0 0.0
.text 112 112 0 0.0
ota-requestor cyw930739m2evb_01 (read/write) 563287 563287 0 0.0
.app_xip_area 454897 454897 0 0.0
.bss 63272 63272 0 0.0
.data 696 696 0 0.0
.rodata 0 0 0 0.0
.text 112 112 0 0.0
switch cyw930739m2evb_01 (read/write) 558831 558831 0 0.0
.app_xip_area 447209 447209 0 0.0
.bss 66392 66392 0 0.0
.data 804 804 0 0.0
.rodata 0 0 0 0.0
.text 112 112 0 0.0
esp32 all-clusters-app c3devkit (read only) 1153886 1153886 0 0.0
(read/write) 1669488 1669488 0 0.0
.dram0.bss 71656 71656 0 0.0
.dram0.data 13588 13588 0 0.0
.flash.rodata 240240 240240 0 0.0
.flash.text 1153886 1153886 0 0.0
.iram0.text 75530 75530 0 0.0
m5stack (read only) 1200131 1200131 0 0.0
(read/write) 520108 520108 0 0.0
.dram0.bss 78520 78520 0 0.0
.dram0.data 35132 35132 0 0.0
.flash.rodata 270536 270536 0 0.0
.flash.text 1193967 1193967 0 0.0
.iram0.text 125403 125403 0 0.0
k32w contact k32w0+release (read only) 606840 606840 0 0.0
(read/write) 81172 81172 0 0.0
.bss 68952 68952 0 0.0
.data 2236 2236 0 0.0
.text 606304 606304 0 0.0
k32w1+release (read only) 1024 1024 0 0.0
(read/write) 692116 692116 0 0.0
.bss 67608 67608 0 0.0
.data 2788 2788 0 0.0
.text 578248 578248 0 0.0
light k32w0+release (read only) 596184 596184 0 0.0
(read/write) 79188 79188 0 0.0
.bss 67016 67016 0 0.0
.data 2188 2188 0 0.0
.text 595648 595648 0 0.0
k32w1+release (read only) 1024 1024 0 0.0
(read/write) 783928 783928 0 0.0
.bss 77284 77284 0 0.0
.data 2000 2000 0 0.0
.text 661192 661192 0 0.0
lock k32w0+release (read only) 577656 577656 0 0.0
(read/write) 78644 78644 0 0.0
.bss 66496 66496 0 0.0
.data 2164 2164 0 0.0
.text 577120 577120 0 0.0
linux air-purifier-app debug (read only) 2535309 2535309 0 0.0
(read/write) 127192 127192 0 0.0
.bss 46272 46272 0 0.0
.data 2144 2144 0 0.0
.data.rel.ro 72856 72856 0 0.0
.dynamic 608 608 0 0.0
.got 4552 4552 0 0.0
.init 27 27 0 0.0
.init_array 752 752 0 0.0
.rodata 179688 179688 0 0.0
.text 2180341 2180341 0 0.0
all-clusters-app debug (read only) 5435593 5435593 0 0.0
(read/write) 458208 458208 0 0.0
.bss 131216 131216 0 0.0
.data 4448 4448 0 0.0
.data.rel.ro 315352 315352 0 0.0
.dynamic 624 624 0 0.0
.got 5336 5336 0 0.0
.init 27 27 0 0.0
.init_array 1224 1224 0 0.0
.rodata 314012 314012 0 0.0
.text 4709395 4709395 0 0.0
all-clusters-minimal-app debug (read only) 4961265 4961265 0 0.0
(read/write) 234640 234640 0 0.0
.bss 127216 127216 0 0.0
.data 4384 4384 0 0.0
.data.rel.ro 95976 95976 0 0.0
.dynamic 624 624 0 0.0
.got 5296 5296 0 0.0
.init 27 27 0 0.0
.init_array 1112 1112 0 0.0
.rodata 271949 271949 0 0.0
.text 4457027 4457027 0 0.0
bridge-app debug (read only) 4426473 4426473 0 0.0
(read/write) 215976 215976 0 0.0
.bss 117816 117816 0 0.0
.data 6144 6144 0 0.0
.data.rel.ro 85312 85312 0 0.0
.dynamic 624 624 0 0.0
.got 5264 5264 0 0.0
.init 27 27 0 0.0
.init_array 808 808 0 0.0
.rodata 219509 219509 0 0.0
.text 3988419 3988419 0 0.0
chip-tool debug (read only) 11782833 11782833 0 0.0
(read/write) 506264 506264 0 0.0
.bss 94200 94200 0 0.0
.data 5058 5058 0 0.0
.data.rel.ro 399792 399792 0 0.0
.dynamic 624 624 0 0.0
.got 5784 5784 0 0.0
.init 27 27 0 0.0
.init_array 760 760 0 0.0
.rodata 429657 429657 0 0.0
.text 10663363 10663363 0 0.0
chip-tool-ipv6only arm64 (read only) 11357216 11357216 0 0.0
(read/write) 576232 576232 0 0.0
.bss 103256 103256 0 0.0
.data 4472 4472 0 0.0
.data.rel.ro 439024 439024 0 0.0
.dynamic 512 512 0 0.0
.got 20040 20040 0 0.0
.init 24 24 0 0.0
.init_array 240 240 0 0.0
.rodata 340332 340332 0 0.0
.text 10146652 10146652 0 0.0
lighting-app debug+rpc+ui (read only) 5311121 5311121 0 0.0
(read/write) 224936 224936 0 0.0
.bss 118848 118848 0 0.0
.data 4864 4864 0 0.0
.data.rel.ro 93728 93728 0 0.0
.dynamic 672 672 0 0.0
.got 5880 5880 0 0.0
.init 27 27 0 0.0
.init_array 928 928 0 0.0
.rodata 340276 340276 0 0.0
.text 4726131 4726131 0 0.0
lock-app debug (read only) 4511721 4511721 0 0.0
(read/write) 203600 203600 0 0.0
.bss 113248 113248 0 0.0
.data 4096 4096 0 0.0
.data.rel.ro 79544 79544 0 0.0
.dynamic 624 624 0 0.0
.got 5216 5216 0 0.0
.init 27 27 0 0.0
.init_array 840 840 0 0.0
.rodata 247445 247445 0 0.0
.text 4054275 4054275 0 0.0
ota-provider-app debug (read only) 4175953 4175953 0 0.0
(read/write) 192680 192680 0 0.0
.bss 113248 113248 0 0.0
.data 4256 4256 0 0.0
.data.rel.ro 69312 69312 0 0.0
.dynamic 624 624 0 0.0
.got 4528 4528 0 0.0
.init 27 27 0 0.0
.init_array 704 704 0 0.0
.rodata 201781 201781 0 0.0
.text 3782323 3782323 0 0.0
ota-requestor-app debug (read only) 4266833 4266833 0 0.0
(read/write) 196960 196960 0 0.0
.bss 114144 114144 0 0.0
.data 4656 4656 0 0.0
.data.rel.ro 72288 72288 0 0.0
.dynamic 624 624 0 0.0
.got 4464 4464 0 0.0
.init 27 27 0 0.0
.init_array 760 760 0 0.0
.rodata 205589 205589 0 0.0
.text 3865091 3865091 0 0.0
shell debug (read only) 2802969 2802969 0 0.0
(read/write) 152704 152704 0 0.0
.bss 61832 61832 0 0.0
.data 1344 1344 0 0.0
.data.rel.ro 83784 83784 0 0.0
.dynamic 592 592 0 0.0
.got 4088 4088 0 0.0
.init 27 27 0 0.0
.init_array 1040 1040 0 0.0
.rodata 182016 182016 0 0.0
.text 2449746 2449746 0 0.0
thermostat-no-ble arm64 (read only) 4355544 4355544 0 0.0
(read/write) 245728 245728 0 0.0
.bss 121624 121624 0 0.0
.data 3328 3328 0 0.0
.data.rel.ro 102776 102776 0 0.0
.dynamic 512 512 0 0.0
.got 12088 12088 0 0.0
.init 24 24 0 0.0
.init_array 416 416 0 0.0
.rodata 155916 155916 0 0.0
.text 3857084 3857084 0 0.0
tv-app debug (read only) 5412993 5412993 0 0.0
(read/write) 349128 349128 0 0.0
.bss 243136 243136 0 0.0
.data 6464 6464 0 0.0
.data.rel.ro 92248 92248 0 0.0
.dynamic 624 624 0 0.0
.got 5512 5512 0 0.0
.init 27 27 0 0.0
.init_array 1120 1120 0 0.0
.rodata 273493 273493 0 0.0
.text 4901875 4901875 0 0.0
tv-casting-app debug (read only) 9654665 9654665 0 0.0
(read/write) 338080 338080 0 0.0
.bss 155936 155936 0 0.0
.data 2912 2912 0 0.0
.data.rel.ro 172384 172384 0 0.0
.dynamic 624 624 0 0.0
.got 5064 5064 0 0.0
.init 27 27 0 0.0
.init_array 1144 1144 0 0.0
.rodata 365800 365800 0 0.0
.text 8827171 8827171 0 0.0
mbed lock-app-release cy8cproto_062_4343w (read only) 6224 6224 0 0.0
(read/write) 2527112 2527112 0 0.0
.bss 220240 220240 0 0.0
.data 5208 5208 0 0.0
.text 1489796 1489796 0 0.0
nrfconnect all-clusters-app nrf52840dk_nrf52840 (read only) 4 4 0 0.0
(read/write) 1075376 1075376 0 0.0
bss 129403 129403 0 0.0
rodata 106752 106752 0 0.0
text 791520 791520 0 0.0
nrf7002dk_nrf5340_cpuapp (read only) 4 4 0 0.0
(read/write) 1200292 1200292 0 0.0
bss 121613 121613 0 0.0
rodata 139600 139600 0 0.0
text 788600 788600 0 0.0
all-clusters-minimal-app nrf52840dk_nrf52840 (read only) 4 4 0 0.0
(read/write) 1041448 1041448 0 0.0
bss 129300 129300 0 0.0
rodata 98888 98888 0 0.0
text 765448 765448 0 0.0
psoc6 all-clusters cy8ckit_062s2_43012 (read only) 835696 835696 0 0.0
(read/write) 1761028 1761028 0 0.0
.bss 195020 195020 0 0.0
.data 2624 2624 0 0.0
.text 1554996 1554996 0 0.0
all-clusters-minimal cy8ckit_062s2_43012 (read only) 837816 837816 0 0.0
(read/write) 1707524 1707524 0 0.0
.bss 192908 192908 0 0.0
.data 2616 2616 0 0.0
.text 1503612 1503612 0 0.0
light cy8ckit_062s2_43012 (read only) 844504 844504 0 0.0
(read/write) 1632444 1632444 0 0.0
.bss 186404 186404 0 0.0
.data 2432 2432 0 0.0
.text 1435220 1435220 0 0.0
lock cy8ckit_062s2_43012 (read only) 817384 817384 0 0.0
(read/write) 1659348 1659348 0 0.0
.bss 213500 213500 0 0.0
.data 2456 2456 0 0.0
.text 1435004 1435004 0 0.0
qpg lighting-app qpg6105+debug (read/write) 1117960 1117960 0 0.0
.bss 101224 101224 0 0.0
.data 808 808 0 0.0
.text 630340 630340 0 0.0
lock-app qpg6105+debug (read/write) 1081936 1081936 0 0.0
.bss 97520 97520 0 0.0
.data 852 852 0 0.0
.text 594312 594312 0 0.0
telink air-quality-sensor-app tlsr9528a_retention (read only) 51774 51774 0 0.0
(read/write) 822594 822594 0 0.0
bss 50916 50916 0 0.0
text 614800 614800 0 0.0
all-clusters-app tlsr9518adk80d (read only) 4 4 0 0.0
(read/write) 1090060 1090060 0 0.0
bss 100384 100384 0 0.0
text 769954 769954 0 0.0
all-clusters-minimal-app tlsr9528a (read only) 4 4 0 0.0
(read/write) 1085496 1085496 0 0.0
bss 109696 109696 0 0.0
text 754632 754632 0 0.0
bridge-app tlsr9518adk80d (read only) 4 4 0 0.0
(read/write) 935944 935944 0 0.0
bss 93664 93664 0 0.0
text 647880 647880 0 0.0
contact-sensor-app tlsr9528a_retention (read only) 51774 51774 0 0.0
(read/write) 822830 822830 0 0.0
bss 50960 50960 0 0.0
text 615170 615170 0 0.0
light-switch-app-ota-shell-factory-data tlsr9528a (read only) 4 4 0 0.0
(read/write) 980468 980468 0 0.0
bss 79004 79004 0 0.0
text 695692 695692 0 0.0
lighting-app-ota-rpc-factory-data-4mb tlsr9518adk80d (read only) 4 4 0 0.0
(read/write) 1094524 1094524 0 0.0
bss 99840 99840 0 0.0
text 771006 771006 0 0.0
lock-app-dfu tlsr9528a (read only) 4 4 0 0.0
(read/write) 966552 966552 0 0.0
bss 97304 97304 0 0.0
text 648938 648938 0 0.0
ota-requestor-app tlsr9518adk80d (read only) 4 4 0 0.0
(read/write) 949880 949880 0 0.0
bss 92348 92348 0 0.0
text 664248 664248 0 0.0
pump-app tlsr9528a (read only) 4 4 0 0.0
(read/write) 881732 881732 0 0.0
bss 69032 69032 0 0.0
text 623286 623286 0 0.0
pump-controller-app tlsr9518adk80d (read only) 4 4 0 0.0
(read/write) 822384 822384 0 0.0
bss 57276 57276 0 0.0
text 590210 590210 0 0.0
shell tlsr9518adk80d (read only) 4 4 0 0.0
(read/write) 705632 705632 0 0.0
bss 73568 73568 0 0.0
text 462136 462136 0 0.0
smoke_co_alarm-app tlsr9528a_retention (read only) 51774 51774 0 0.0
(read/write) 824558 824558 0 0.0
bss 51096 51096 0 0.0
text 617914 617914 0 0.0
temperature-measurement-app-mars-ota tlsr9518adk80d (read only) 4 4 0 0.0
(read/write) 879609 879609 0 0.0
bss 60744 60744 0 0.0
text 632106 632106 0 0.0
thermostat tlsr9518adk80d (read only) 4 4 0 0.0
(read/write) 846748 846748 0 0.0
bss 57564 57564 0 0.0
text 608676 608676 0 0.0
window-covering tlsr9518adk80d (read only) 4 4 0 0.0
(read/write) 840948 840948 0 0.0
bss 57880 57880 0 0.0
text 602630 602630 0 0.0

Copy link
Contributor

@Damian-Nordic Damian-Nordic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the getting started guides overlap with the existing documentation. I wonder if the existing doc cannot be updated instead of adding an alternative tree?

docs/getting_started/coding_conventions.md Outdated Show resolved Hide resolved
docs/getting_started/building_and_running_an_example.md Outdated Show resolved Hide resolved
docs/getting_started/working_in_github.md Outdated Show resolved Hide resolved
docs/getting_started/index.md Outdated Show resolved Hide resolved
docs/getting_started/SDKBasics.md Outdated Show resolved Hide resolved
docs/getting_started/SDKBasics.md Outdated Show resolved Hide resolved
docs/getting_started/SDKBasics.md Outdated Show resolved Hide resolved
docs/getting_started/SDKBasics.md Outdated Show resolved Hide resolved
docs/getting_started/zap.md Show resolved Hide resolved
docs/getting_started/coding_conventions.md Outdated Show resolved Hide resolved
docs/cluster_and_device_type_dev/index.md Outdated Show resolved Hide resolved
@cecille
Copy link
Contributor Author

cecille commented Jan 16, 2024

@Damian-Nordic LMK if you want me to remove the rest of the getting started directory.

@Damian-Nordic
Copy link
Contributor

@Damian-Nordic LMK if you want me to remove the rest of the getting started directory.

No, the rest is fine. Just wanted to avoid parallel development of overlapping articles.

@ReneJosefsen
Copy link
Contributor

Do you need to mark the files as orphan to make the CI happy?

@cecille
Copy link
Contributor Author

cecille commented Jan 16, 2024

No, I'm trying to get them added to the toctree. But I keep having to push it through the ci becuase i can't build locally

@ReneJosefsen
Copy link
Contributor

No, I'm trying to get them added to the toctree. But I keep having to push it through the ci becuase i can't build locally

Oh okay, fair. Then that should not be the problem at hand.

@cecille cecille merged commit 9787185 into project-chip:master Jan 17, 2024
60 checks passed
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 github review - approved
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants