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: update chip name to Matter and misc edits #10561

Merged

Conversation

greg-fer
Copy link
Contributor

@greg-fer greg-fer commented Oct 15, 2021

Problem

  • CHIP is still used across docs

Change overview

  • Updated CHIP to Matter in relevant parts of the docs, for common guides and nrfconnect pages. Other platform pages were not touched.
  • Minor fixes to the structure of the guide about building Android tools.
  • Minor terminology fixes to WiFi (correct spelling Wi-Fi) and BLE (correct spelling Bluetooth LE).

Testing

Doc change only.

Update CHIP to Matter in top-level readme and contributing.md.

Signed-off-by: Grzegorz Ferenc <[email protected]>
Updated CHIP to Matter in non-nrfconnect generic examples.

Signed-off-by: Grzegorz Ferenc <[email protected]>
Updated CHIP to Matter on nrfconnect pages.

Signed-off-by: Grzegorz Ferenc <[email protected]>
Updated CHIP to Matter in tool guides.
Updated structure of the Android guide.

Signed-off-by: Grzegorz Ferenc <[email protected]>
Changed CHIP to Matter in md files in docs/.

Signed-off-by: Grzegorz Ferenc <[email protected]>
@github-actions
Copy link

github-actions bot commented Oct 15, 2021

PR #10561: Size comparison from a56c83e to 19c94b7

5 builds
platform target config section a56c83e 19c94b7 change % change
p6 lock-app default .bss 68224 68224 0 0.0
.data 2416 2416 0 0.0
.heap 962704 962704 0 0.0
.text 1126784 1126784 0 0.0
qpg lighting-app qpg6100+debug .bss 53536 53536 0 0.0
.data 996 996 0 0.0
.text 486504 486504 0 0.0
lock-app qpg6100+debug .bss 52488 52488 0 0.0
.data 952 952 0 0.0
.text 462696 462696 0 0.0
persistent-storage-app qpg6100+debug .bss 17778 17778 0 0.0
.data 280 280 0 0.0
.text 102704 102704 0 0.0
telink lighting-app tlsr9518adk80d bss 70988 70988 0 0.0
noinit 33216 33216 0 0.0
text 458530 458530 0 0.0
15 builds
platform target config section a56c83e 19c94b7 change % change
efr32 lighting-app BRD4161A .bss 118020 118020 0 0.0
.data 1800 1800 0 0.0
.text 782924 782924 0 0.0
lock-app BRD4161A .bss 115892 115892 0 0.0
.data 1760 1760 0 0.0
.text 762180 762180 0 0.0
window-app BRD4161A .bss 116212 116212 0 0.0
.data 1764 1764 0 0.0
.text 763088 763088 0 0.0
lighting-app BRD4161A+rpc .bss 131348 131348 0 0.0
.data 1852 1852 0 0.0
.text 762668 762668 0 0.0
k32w lock-app k32w061+debug .bss 69052 69052 0 0.0
.data 1864 1864 0 0.0
.text 515572 515572 0 0.0
shell k32w061+debug .bss 55080 55080 0 0.0
.data 672 672 0 0.0
.text 357680 357680 0 0.0
lighting-app k32w061+se05x+release .bss 78568 78568 0 0.0
.data 1900 1900 0 0.0
.text 614244 614244 0 0.0
linux all-clusters-app debug .bss 52176 52176 0 0.0
.data 978 978 0 0.0
.data.rel.ro 58416 58416 0 0.0
.dynamic 592 592 0 0.0
.got 4072 4072 0 0.0
.init 27 27 0 0.0
.init_array 512 512 0 0.0
.rodata 135797 135797 0 0.0
.text 1322610 1322610 0 0.0
chip-tool debug .bss 17584 17584 0 0.0
.data 1584 1584 0 0.0
.data.rel.ro 83312 83312 0 0.0
.dynamic 592 592 0 0.0
.got 4328 4328 0 0.0
.init 27 27 0 0.0
.init_array 424 424 0 0.0
.rodata 174560 174560 0 0.0
.text 2423429 2423429 0 0.0
ota-provider-app debug .bss 37504 37504 0 0.0
.data 752 752 0 0.0
.data.rel.ro 23192 23192 0 0.0
.dynamic 592 592 0 0.0
.got 4008 4008 0 0.0
.init 27 27 0 0.0
.init_array 448 448 0 0.0
.rodata 109856 109856 0 0.0
.text 1010258 1010258 0 0.0
ota-requestor-app debug .bss 205760 205760 0 0.0
.data 752 752 0 0.0
.data.rel.ro 24488 24488 0 0.0
.dynamic 592 592 0 0.0
.got 4136 4136 0 0.0
.init 27 27 0 0.0
.init_array 520 520 0 0.0
.rodata 127936 127936 0 0.0
.text 1129922 1129922 0 0.0
shell debug .bss 16104 16104 0 0.0
.data 242 242 0 0.0
.data.rel.ro 35184 35184 0 0.0
.dynamic 592 592 0 0.0
.got 3504 3504 0 0.0
.init 27 27 0 0.0
.init_array 344 344 0 0.0
.rodata 72143 72143 0 0.0
.text 575314 575314 0 0.0
tv-app debug .bss 216400 216400 0 0.0
.data 2032 2032 0 0.0
.data.rel.ro 55568 55568 0 0.0
.dynamic 592 592 0 0.0
.got 4408 4408 0 0.0
.init 27 27 0 0.0
.init_array 616 616 0 0.0
.rodata 151560 151560 0 0.0
.text 1468146 1468146 0 0.0
bridge-app debug+rpc .bss 52912 52912 0 0.0
.data 976 976 0 0.0
.data.rel.ro 25512 25512 0 0.0
.dynamic 592 592 0 0.0
.got 3944 3944 0 0.0
.init 27 27 0 0.0
.init_array 408 408 0 0.0
.rodata 110548 110548 0 0.0
.text 1051877 1051877 0 0.0
lighting-app debug+rpc .bss 42232 42232 0 0.0
.data 1106 1106 0 0.0
.data.rel.ro 52256 52256 0 0.0
.dynamic 608 608 0 0.0
.got 4104 4104 0 0.0
.init 27 27 0 0.0
.init_array 536 536 0 0.0
.rodata 127665 127665 0 0.0
.text 1253026 1253026 0 0.0
2 builds
platform target config section a56c83e 19c94b7 change % change
mbed lighting-app CY8CPROTO_062_4343W+release .bss 172148 172148 0 0.0
.data 5464 5464 0 0.0
.heap 858832 858832 0 0.0
.text 1220096 1220096 0 0.0
lock-app CY8CPROTO_062_4343W+release .bss 171084 171084 0 0.0
.data 5432 5432 0 0.0
.heap 859928 859928 0 0.0
.text 1198080 1198080 0 0.0
12 builds
platform target config section a56c83e 19c94b7 change % change
esp32 all-clusters-app c3devkit .dram0.bss 60264 60264 0 0.0
.dram0.data 16232 16232 0 0.0
.flash.rodata 198632 198632 0 0.0
.flash.text 870358 870358 0 0.0
.iram0.text 57330 57330 0 0.0
m5stack .dram0.bss 62768 62768 0 0.0
.dram0.data 32084 32084 0 0.0
.flash.rodata 207212 207212 0 0.0
.flash.text 901511 901511 0 0.0
.iram0.text 125115 125115 0 0.0
nrfconnect lighting-app nrf52840dk_nrf52840 bss 112320 112320 0 0.0
rodata 97632 97632 0 0.0
text 577824 577824 0 0.0
lock-app nrf52840dk_nrf52840 bss 111352 111352 0 0.0
rodata 94128 94128 0 0.0
text 559264 559264 0 0.0
pigweed-app nrf52840dk_nrf52840 bss 51772 51772 0 0.0
rodata 45772 45772 0 0.0
text 339392 339392 0 0.0
pump-app nrf52840dk_nrf52840 bss 111420 111420 0 0.0
rodata 95112 95112 0 0.0
text 562436 562436 0 0.0
pump-controller-app nrf52840dk_nrf52840 bss 111360 111360 0 0.0
rodata 94188 94188 0 0.0
text 559040 559040 0 0.0
shell nrf52840dk_nrf52840 bss 107320 107320 0 0.0
rodata 71788 71788 0 0.0
text 519308 519308 0 0.0
lighting-app nrf52840dk_nrf52840+rpc bss 108560 108560 0 0.0
rodata 88416 88416 0 0.0
text 551028 551028 0 0.0
nrf5340dk_nrf5340_cpuapp bss 113692 113692 0 0.0
rodata 92872 92872 0 0.0
text 507284 507284 0 0.0
lock-app nrf5340dk_nrf5340_cpuapp bss 112724 112724 0 0.0
rodata 89388 89388 0 0.0
text 488720 488720 0 0.0
shell nrf5340dk_nrf5340_cpuapp bss 108304 108304 0 0.0
rodata 66432 66432 0 0.0
text 439908 439908 0 0.0

@greg-fer greg-fer changed the title Doc update chip name shorten titles docs: update chip name to Matter and misc edits Oct 15, 2021
@andy31415
Copy link
Contributor

@greg-fer - it looks like some works need to be added to the spellchecker word list.

restyled-commits and others added 2 commits October 18, 2021 15:57
Updated .wordlist with CSA.

Signed-off-by: Grzegorz Ferenc <[email protected]>
@greg-fer greg-fer force-pushed the doc_update_chip_name_shorten_titles branch from 19c94b7 to be24c12 Compare October 18, 2021 13:59
@boring-cyborg boring-cyborg bot added the github label Oct 18, 2021
@github-actions
Copy link

github-actions bot commented Oct 18, 2021

PR #10561: Size comparison from 5c2afb7 to be24c12

8 builds
platform target config section 5c2afb7 be24c12 change % change
k32w lock-app k32w061+debug .bss 69052 69052 0 0.0
.data 1864 1864 0 0.0
.text 515176 515176 0 0.0
shell k32w061+debug .bss 55080 55080 0 0.0
.data 672 672 0 0.0
.text 357172 357172 0 0.0
lighting-app k32w061+se05x+release .bss 78560 78560 0 0.0
.data 1900 1900 0 0.0
.text 613800 613800 0 0.0
p6 lock-app default .bss 68216 68216 0 0.0
.data 2416 2416 0 0.0
.heap 962712 962712 0 0.0
.text 1126280 1126280 0 0.0
qpg lighting-app qpg6100+debug .bss 53536 53536 0 0.0
.data 996 996 0 0.0
.text 486104 486104 0 0.0
lock-app qpg6100+debug .bss 52488 52488 0 0.0
.data 952 952 0 0.0
.text 462352 462352 0 0.0
persistent-storage-app qpg6100+debug .bss 17778 17778 0 0.0
.data 280 280 0 0.0
.text 102704 102704 0 0.0
telink lighting-app tlsr9518adk80d bss 70984 70984 0 0.0
noinit 33216 33216 0 0.0
text 458146 458146 0 0.0
14 builds
platform target config section 5c2afb7 be24c12 change % change
efr32 lighting-app BRD4161A .bss 118020 118020 0 0.0
.data 1800 1800 0 0.0
.text 782420 782420 0 0.0
lock-app BRD4161A .bss 115892 115892 0 0.0
.data 1760 1760 0 0.0
.text 761724 761724 0 0.0
window-app BRD4161A .bss 116212 116212 0 0.0
.data 1764 1764 0 0.0
.text 762632 762632 0 0.0
lighting-app BRD4161A+rpc .bss 131348 131348 0 0.0
.data 1852 1852 0 0.0
.text 762148 762148 0 0.0
linux all-clusters-app debug .bss 52176 52176 0 0.0
.data 978 978 0 0.0
.data.rel.ro 58432 58432 0 0.0
.dynamic 592 592 0 0.0
.got 4072 4072 0 0.0
.init 27 27 0 0.0
.init_array 512 512 0 0.0
.rodata 135989 135989 0 0.0
.text 1326066 1326066 0 0.0
chip-tool debug .bss 17552 17552 0 0.0
.data 1584 1584 0 0.0
.data.rel.ro 83312 83312 0 0.0
.dynamic 592 592 0 0.0
.got 4336 4336 0 0.0
.init 27 27 0 0.0
.init_array 416 416 0 0.0
.rodata 174560 174560 0 0.0
.text 2422885 2422885 0 0.0
ota-provider-app debug .bss 37472 37472 0 0.0
.data 752 752 0 0.0
.data.rel.ro 23176 23176 0 0.0
.dynamic 592 592 0 0.0
.got 4008 4008 0 0.0
.init 27 27 0 0.0
.init_array 440 440 0 0.0
.rodata 109848 109848 0 0.0
.text 1009314 1009314 0 0.0
ota-requestor-app debug .bss 205728 205728 0 0.0
.data 752 752 0 0.0
.data.rel.ro 24488 24488 0 0.0
.dynamic 592 592 0 0.0
.got 4136 4136 0 0.0
.init 27 27 0 0.0
.init_array 512 512 0 0.0
.rodata 127896 127896 0 0.0
.text 1128626 1128626 0 0.0
shell debug .bss 16072 16072 0 0.0
.data 242 242 0 0.0
.data.rel.ro 35120 35120 0 0.0
.dynamic 592 592 0 0.0
.got 3496 3496 0 0.0
.init 27 27 0 0.0
.init_array 336 336 0 0.0
.rodata 71855 71855 0 0.0
.text 568898 568898 0 0.0
tv-app debug .bss 216368 216368 0 0.0
.data 2032 2032 0 0.0
.data.rel.ro 55536 55536 0 0.0
.dynamic 592 592 0 0.0
.got 4400 4400 0 0.0
.init 27 27 0 0.0
.init_array 608 608 0 0.0
.rodata 151464 151464 0 0.0
.text 1462818 1462818 0 0.0
bridge-app debug+rpc .bss 52880 52880 0 0.0
.data 976 976 0 0.0
.data.rel.ro 25496 25496 0 0.0
.dynamic 592 592 0 0.0
.got 3944 3944 0 0.0
.init 27 27 0 0.0
.init_array 400 400 0 0.0
.rodata 110484 110484 0 0.0
.text 1050821 1050821 0 0.0
lighting-app debug+rpc .bss 42200 42200 0 0.0
.data 1106 1106 0 0.0
.data.rel.ro 52240 52240 0 0.0
.dynamic 608 608 0 0.0
.got 4104 4104 0 0.0
.init 27 27 0 0.0
.init_array 528 528 0 0.0
.rodata 127665 127665 0 0.0
.text 1252226 1252226 0 0.0
mbed lighting-app CY8CPROTO_062_4343W+release .bss 172148 172148 0 0.0
.data 5464 5464 0 0.0
.heap 858832 858832 0 0.0
.text 1219384 1219384 0 0.0
lock-app CY8CPROTO_062_4343W+release .bss 171084 171084 0 0.0
.data 5432 5432 0 0.0
.heap 859928 859928 0 0.0
.text 1197440 1197440 0 0.0
12 builds
platform target config section 5c2afb7 be24c12 change % change
esp32 all-clusters-app c3devkit .dram0.bss 60280 60280 0 0.0
.dram0.data 16192 16192 0 0.0
.flash.rodata 198624 198624 0 0.0
.flash.text 870142 870142 0 0.0
.iram0.text 57330 57330 0 0.0
m5stack .dram0.bss 62776 62776 0 0.0
.dram0.data 32084 32084 0 0.0
.flash.rodata 207056 207056 0 0.0
.flash.text 900599 900507 -92 -0.0
.iram0.text 125115 125115 0 0.0
nrfconnect lighting-app nrf52840dk_nrf52840 bss 112316 112316 0 0.0
rodata 97528 97528 0 0.0
text 577428 577428 0 0.0
lock-app nrf52840dk_nrf52840 bss 111348 111348 0 0.0
rodata 94028 94028 0 0.0
text 558928 558928 0 0.0
pigweed-app nrf52840dk_nrf52840 bss 51772 51772 0 0.0
rodata 45772 45772 0 0.0
text 339392 339392 0 0.0
pump-app nrf52840dk_nrf52840 bss 111416 111416 0 0.0
rodata 95008 95008 0 0.0
text 562084 562084 0 0.0
pump-controller-app nrf52840dk_nrf52840 bss 111356 111356 0 0.0
rodata 94088 94088 0 0.0
text 558720 558720 0 0.0
shell nrf52840dk_nrf52840 bss 107316 107316 0 0.0
rodata 71640 71640 0 0.0
text 518908 518908 0 0.0
lighting-app nrf52840dk_nrf52840+rpc bss 108556 108556 0 0.0
rodata 88320 88320 0 0.0
text 550632 550632 0 0.0
nrf5340dk_nrf5340_cpuapp bss 113688 113688 0 0.0
rodata 92772 92772 0 0.0
text 506888 506888 0 0.0
lock-app nrf5340dk_nrf5340_cpuapp bss 112720 112720 0 0.0
rodata 89284 89284 0 0.0
text 488380 488380 0 0.0
shell nrf5340dk_nrf5340_cpuapp bss 108300 108300 0 0.0
rodata 66284 66284 0 0.0
text 439504 439504 0 0.0

Copy link
Contributor

@LuDuda LuDuda left a comment

Choose a reason for hiding this comment

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

Thanks 👍

@andy31415 andy31415 merged commit bae3e7d into project-chip:master Oct 19, 2021
JasonLiuZhuoCheng pushed a commit to JasonLiuZhuoCheng/connectedhomeip that referenced this pull request Oct 19, 2021
* doc: update CHIP name on intro pages

Update CHIP to Matter in top-level readme and contributing.md.

Signed-off-by: Grzegorz Ferenc <[email protected]>

* doc: update CHIP name in generic examples

Updated CHIP to Matter in non-nrfconnect generic examples.

Signed-off-by: Grzegorz Ferenc <[email protected]>

* doc: update CHIP name on nrfconnect pages

Updated CHIP to Matter on nrfconnect pages.

Signed-off-by: Grzegorz Ferenc <[email protected]>

* doc: update CHIP name in tool guides

Updated CHIP to Matter in tool guides.
Updated structure of the Android guide.

Signed-off-by: Grzegorz Ferenc <[email protected]>

* doc: update CHIP name in docs/ files

Changed CHIP to Matter in md files in docs/.

Signed-off-by: Grzegorz Ferenc <[email protected]>

* Restyled by prettier-markdown

* wordlist: add CSA term

Updated .wordlist with CSA.

Signed-off-by: Grzegorz Ferenc <[email protected]>

Co-authored-by: Restyled.io <[email protected]>
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 examples github review - approved
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants