doc: tools: add tools section and pages #26262

greg-fer · 2023-04-26T14:39:58Z

Added tools section and pages in documentation.
This adds readmies for chip-cert and spake2p to the doc pool.

github-actions · 2023-04-26T15:07:59Z

PR #26262: Size comparison from 23a8e5a to b3f917a

Increases (2 builds for cc32xx, nrfconnect)

platform	target	config	section	23a8e5ae	`b3f917a`	change	% change
cc32xx	lock	CC3235SF_LAUNCHXL	.debug_info	19489249	19489251	2	0.0
nrfconnect	all-clusters-app	nrf7002dk_nrf5340_cpuapp	text	775880	775884	4	0.0

Full report (5 builds for cc32xx, mbed, nrfconnect)

platform	target	config	section	23a8e5ae	`b3f917a`	change
cc32xx	lock	CC3235SF_LAUNCHXL		0	0	0
			(read only)	601114	601114	0
			(read/write)	204132	204132	0
			.ARM.attributes	44	44	0
			.ARM.exidx	8	8	0
			.bss	197544	197544	0
			.comment	206	206	0
			.data	1468	1468	0
			.debug_abbrev	956756	956756	0
			.debug_aranges	103416	103416	0
			.debug_frame	349704	349704	0
			.debug_info	19489249	19489251	2
			.debug_line	2678035	2678035	0
			.debug_line_str	513	513	0
			.debug_loc	33340	33340	0
			.debug_loclists	1501882	1501882	0
			.debug_ranges	4984	4984	0
			.debug_rnglists	96008	96008	0
			.debug_str	3024877	3024877	0
			.ramVecs	780	780	0
			.resetVecs	64	64	0
			.rodata	104170	104170	0
			.shstrtab	265	265	0
			.stack	2048	2048	0
			.strtab	477531	477531	0
			.symtab	285936	285936	0
			.text	494824	494824	0
mbed	lock-app	CY8CPROTO_062_4343W+release	(read only)	6224	6224	0
			(read/write)	2492536	2492536	0
			.bss	216272	216272	0
			.data	5144	5144	0
			.text	`1455220`	`1455220`	0
nrfconnect	all-clusters-app	nrf52840dk_nrf52840	(read only)	4	4	0
			(read/write)	1174052	1174052	0
			bss	155569	155569	0
			rodata	132804	132804	0
			text	804928	804928	0
	all-clusters-minimal-app	nrf52840dk_nrf52840	(read only)	4	4	0
			(read/write)	1119300	1119300	0
			bss	154725	154725	0
			rodata	109620	109620	0
			text	774324	774324	0
	all-clusters-app	nrf7002dk_nrf5340_cpuapp	(read only)	4	4	0
			(read/write)	1434112	1434112	0
			bss	135309	135309	0
			rodata	228848	228848	0
			text	775880	775884	4

github-actions · 2023-04-27T08:42:18Z

PR #26262: Size comparison from c1108d7 to aced677

Full report (1 build for cc32xx)

platform	target	config	section	`c1108d7`	`aced677`
cc32xx	lock	CC3235SF_LAUNCHXL		0	0
			(read only)	601114	601114
			(read/write)	204132	204132
			.ARM.attributes	44	44
			.ARM.exidx	8	8
			.bss	197544	197544
			.comment	206	206
			.data	1468	1468
			.debug_abbrev	956756	956756
			.debug_aranges	103416	103416
			.debug_frame	349704	349704
			.debug_info	19489250	19489250
			.debug_line	2678035	2678035
			.debug_line_str	513	513
			.debug_loc	33340	33340
			.debug_loclists	1501882	1501882
			.debug_ranges	4984	4984
			.debug_rnglists	96008	96008
			.debug_str	3024877	3024877
			.ramVecs	780	780
			.resetVecs	64	64
			.rodata	104170	104170
			.shstrtab	265	265
			.stack	2048	2048
			.strtab	477531	477531
			.symtab	285936	285936
			.text	494824	494824

github-actions · 2023-04-27T12:05:58Z

PR #26262: Size comparison from c1108d7 to dd87dc7

Full report (1 build for cc32xx)

platform	target	config	section	`c1108d7`	`dd87dc7`
cc32xx	lock	CC3235SF_LAUNCHXL		0	0
			(read only)	601114	601114
			(read/write)	204132	204132
			.ARM.attributes	44	44
			.ARM.exidx	8	8
			.bss	197544	197544
			.comment	206	206
			.data	1468	1468
			.debug_abbrev	956756	956756
			.debug_aranges	103416	103416
			.debug_frame	349704	349704
			.debug_info	19489250	19489250
			.debug_line	2678035	2678035
			.debug_line_str	513	513
			.debug_loc	33340	33340
			.debug_loclists	1501882	1501882
			.debug_ranges	4984	4984
			.debug_rnglists	96008	96008
			.debug_str	3024877	3024877
			.ramVecs	780	780
			.resetVecs	64	64
			.rodata	104170	104170
			.shstrtab	265	265
			.stack	2048	2048
			.strtab	477531	477531
			.symtab	285936	285936
			.text	494824	494824

github-actions · 2023-04-27T13:13:51Z

PR #26262: Size comparison from c1108d7 to 5985b5f

Decreases (1 build for cc32xx)

platform	target	config	section	`c1108d7`	`5985b5f`	change	% change
cc32xx	lock	CC3235SF_LAUNCHXL	.debug_info	19489250	19489249	-1	-0.0

Full report (1 build for cc32xx)

platform	target	config	section	`c1108d7`	`5985b5f`	change	% change
cc32xx	lock	CC3235SF_LAUNCHXL		0	0	0	0.0
			(read only)	601114	601114	0	0.0
			(read/write)	204132	204132	0	0.0
			.ARM.attributes	44	44	0	0.0
			.ARM.exidx	8	8	0	0.0
			.bss	197544	197544	0	0.0
			.comment	206	206	0	0.0
			.data	1468	1468	0	0.0
			.debug_abbrev	956756	956756	0	0.0
			.debug_aranges	103416	103416	0	0.0
			.debug_frame	349704	349704	0	0.0
			.debug_info	19489250	19489249	-1	-0.0
			.debug_line	2678035	2678035	0	0.0
			.debug_line_str	513	513	0	0.0
			.debug_loc	33340	33340	0	0.0
			.debug_loclists	1501882	1501882	0	0.0
			.debug_ranges	4984	4984	0	0.0
			.debug_rnglists	96008	96008	0	0.0
			.debug_str	3024877	3024877	0	0.0
			.ramVecs	780	780	0	0.0
			.resetVecs	64	64	0	0.0
			.rodata	104170	104170	0	0.0
			.shstrtab	265	265	0	0.0
			.stack	2048	2048	0	0.0
			.strtab	477531	477531	0	0.0
			.symtab	285936	285936	0	0.0
			.text	494824	494824	0	0.0

gautesl

This still leaves some errors with some links to example folders

docs/conf.py

docs/tools/index.md

github-actions · 2023-04-27T13:45:42Z

PR #26262: Size comparison from c1108d7 to ceeb3e2

Full report (1 build for cc32xx)

platform	target	config	section	`c1108d7`	`ceeb3e2`
cc32xx	lock	CC3235SF_LAUNCHXL		0	0
			(read only)	601114	601114
			(read/write)	204132	204132
			.ARM.attributes	44	44
			.ARM.exidx	8	8
			.bss	197544	197544
			.comment	206	206
			.data	1468	1468
			.debug_abbrev	956756	956756
			.debug_aranges	103416	103416
			.debug_frame	349704	349704
			.debug_info	19489250	19489250
			.debug_line	2678035	2678035
			.debug_line_str	513	513
			.debug_loc	33340	33340
			.debug_loclists	1501882	1501882
			.debug_ranges	4984	4984
			.debug_rnglists	96008	96008
			.debug_str	3024877	3024877
			.ramVecs	780	780
			.resetVecs	64	64
			.rodata	104170	104170
			.shstrtab	265	265
			.stack	2048	2048
			.strtab	477531	477531
			.symtab	285936	285936
			.text	494824	494824

greg-fer · 2023-04-27T14:19:47Z

@andrei-menzopol , I've moved the NXP guide you added from platforms/nxp/doc to docs/guides and added it to the doc pool at https://project-chip.github.io/connectedhomeip-doc/guides/index.html , so the page will be visible there once this is merged. Could you check everything is OK and sign off this change? Thanks!

andrei-menzopol · 2023-04-27T14:36:35Z

@greg-fer, looks good. Thank you.

github-actions · 2023-04-27T14:41:45Z

PR #26262: Size comparison from c1108d7 to 04a58c9

Decreases (1 build for nrfconnect)

platform	target	config	section	`c1108d7`	`04a58c9`	change	% change
nrfconnect	all-clusters-minimal-app	nrf52840dk_nrf52840	text	774696	774692	-4	-0.0

Full report (6 builds for mbed, nrfconnect, qpg)

platform	target	config	section	`c1108d7`	`04a58c9`	change	% change
mbed	lock-app	CY8CPROTO_062_4343W+release	(read only)	6224	6224	0	0.0
			(read/write)	2492536	2492536	0	0.0
			.bss	216272	216272	0	0.0
			.data	5144	5144	0	0.0
			.text	`1455220`	`1455220`	0	0.0
nrfconnect	all-clusters-app	nrf52840dk_nrf52840	(read only)	4	4	0	0.0
			(read/write)	1174448	1174448	0	0.0
			bss	155569	155569	0	0.0
			rodata	132832	132832	0	0.0
			text	805300	805300	0	0.0
	all-clusters-minimal-app	nrf52840dk_nrf52840	(read only)	4	4	0	0.0
			(read/write)	1119700	1119700	0	0.0
			bss	154725	154725	0	0.0
			rodata	109652	109652	0	0.0
			text	774696	774692	-4	-0.0
	all-clusters-app	nrf7002dk_nrf5340_cpuapp	(read only)	4	4	0	0.0
			(read/write)	1434112	1434112	0	0.0
			bss	135309	135309	0	0.0
			rodata	228848	228848	0	0.0
			text	775884	775884	0	0.0
qpg	lighting-app	qpg6105+debug	(read/write)	`1164776`	`1164776`	0	0.0
			.bss	99616	99616	0	0.0
			.data	856	856	0	0.0
			.text	611876	611876	0	0.0
	lock-app	qpg6105+debug	(read/write)	`1134128`	`1134128`	0	0.0
			.bss	94768	94768	0	0.0
			.data	852	852	0	0.0
			.text	581224	581224	0	0.0

Added tools section and pages in documentation. This adds readmies for chip-cert and spake2p to the doc pool. Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>

Moved the NXP manufacturing data guide into docs/guides. Added the guide to the doc pool and updated links. Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>

LuDuda

Thank you Greg!

github-actions bot added the documentation Improvements or additions to documentation label Apr 26, 2023

bzbarsky-apple approved these changes Apr 26, 2023

View reviewed changes

greg-fer force-pushed the doc_tools_add_chip_cert_to_tool_list branch from b3f917a to aced677 Compare April 27, 2023 08:31

github-actions bot added scripts tools labels Apr 27, 2023

greg-fer force-pushed the doc_tools_add_chip_cert_to_tool_list branch from aced677 to dd87dc7 Compare April 27, 2023 11:55

greg-fer force-pushed the doc_tools_add_chip_cert_to_tool_list branch from dd87dc7 to 5985b5f Compare April 27, 2023 12:55

gautesl reviewed Apr 27, 2023

View reviewed changes

greg-fer force-pushed the doc_tools_add_chip_cert_to_tool_list branch from 5985b5f to ceeb3e2 Compare April 27, 2023 13:33

github-actions bot added the examples label Apr 27, 2023

greg-fer and others added 3 commits April 27, 2023 17:28

doc: tools: add tools section and pages

92cf35e

Added tools section and pages in documentation. This adds readmies for chip-cert and spake2p to the doc pool. Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>

doc: move NXP manufacturing guide doc to fix links

6d7ac0f

Moved the NXP manufacturing data guide into docs/guides. Added the guide to the doc pool and updated links. Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>

Restyled by prettier-markdown

20b4aa2

greg-fer force-pushed the doc_tools_add_chip_cert_to_tool_list branch from 9815df7 to 20b4aa2 Compare April 27, 2023 15:28

pullapprove bot requested review from amitnj, andy31415, arkq, chrisdecenzo, chshu, chulspro, cliffamzn and CodeChronos928 April 27, 2023 15:28

pullapprove bot added the review - pending label Apr 27, 2023

LuDuda approved these changes Apr 27, 2023

View reviewed changes

pullapprove bot added review - approved and removed review - pending labels Apr 27, 2023

kkasperczyk-no approved these changes Apr 28, 2023

View reviewed changes

kkasperczyk-no merged commit f1096a5 into project-chip:master Apr 28, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: tools: add tools section and pages #26262

doc: tools: add tools section and pages #26262

greg-fer commented Apr 26, 2023

github-actions bot commented Apr 26, 2023

github-actions bot commented Apr 27, 2023

github-actions bot commented Apr 27, 2023

github-actions bot commented Apr 27, 2023

gautesl left a comment

github-actions bot commented Apr 27, 2023

greg-fer commented Apr 27, 2023

andrei-menzopol commented Apr 27, 2023

github-actions bot commented Apr 27, 2023

LuDuda left a comment

doc: tools: add tools section and pages #26262

doc: tools: add tools section and pages #26262

Conversation

greg-fer commented Apr 26, 2023

github-actions bot commented Apr 26, 2023

github-actions bot commented Apr 27, 2023

github-actions bot commented Apr 27, 2023

github-actions bot commented Apr 27, 2023

gautesl left a comment

Choose a reason for hiding this comment

github-actions bot commented Apr 27, 2023

greg-fer commented Apr 27, 2023

andrei-menzopol commented Apr 27, 2023

github-actions bot commented Apr 27, 2023

LuDuda left a comment

Choose a reason for hiding this comment