Skip to content

Commit 6022261

Browse files
greg-ferrestyled-commits
authored and
pull[bot]
committed
doc: tools: add tools section and pages (#26262)
* doc: tools: add tools section and pages 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 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 --------- Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no> Co-authored-by: Restyled.io <commits@restyled.io>
1 parent d42839d commit 6022261

File tree

12 files changed

+79
-9
lines changed

12 files changed

+79
-9
lines changed

‎docs/conf.py

+5
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@
3232
"examples/thermostat/nxp/linux-se05x/README.md",
3333
"examples/common/m5stack-tft/repo",
3434
"docs/guides/README.md",
35+
"scripts/tools/memory/memdf/README.md",
36+
"scripts/tools/memory/platform/README.md",
37+
"scripts/tools/memory/README-GitHub-CI.md",
3538
]
3639

3740

@@ -69,6 +72,8 @@
6972
(MATTER_BASE, "examples/**/*.png"),
7073
(MATTER_BASE, "examples/**/*.jpg"),
7174
(MATTER_BASE, "examples/**/*.JPG"),
75+
(MATTER_BASE, "src/tools/**/*.md"),
76+
(MATTER_BASE, "scripts/tools/**/*.md"),
7277
]
7378
external_content_link_prefixes = [
7479
"src/",

‎docs/guides/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ esp32/README
3434
- [nRF Connect - Software Update](./nrfconnect_examples_software_update.md)
3535
- [NXP - Android Commissioning](./nxp_k32w_android_commissioning.md)
3636
- [NXP - Linux Examples](./nxp_imx8m_linux_examples.md)
37+
- [NXP - Manufacturing Data](./nxp_manufacturing_flow.md)
3738
- [Silicon Labs - Documentation](https://github.com/SiliconLabs/matter#readme)
3839
- [Silicon Labs - Building](./silabs_efr32_building.md)
3940
- [Silicon Labs - Software Update](./silabs_efr32_software_update.md)

‎examples/platform/nxp/doc/manufacturing_flow.md ‎docs/guides/nxp_manufacturing_flow.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
orphan: true
33
---
44

5-
## Manufacturing data
5+
# NXP manufacturing data guide
66

77
By default, the example application is configured to use generic test
88
certificates and provisioning data embedded with the application code. It is

‎docs/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ discussion/index
1313
guides/index
1414
style/index
1515
examples/index
16+
tools/index
1617
BUG_REPORT
1718
code_generation
1819
ERROR_CODES

‎docs/tools/index.md

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Tools
2+
3+
The Matter SDK provides tools that allow you to generate and manage different
4+
aspects of the Matter development.
5+
6+
## C++ tools
7+
8+
Source files for these tools are located at `src/tools`.
9+
10+
```{toctree}
11+
:glob:
12+
:maxdepth: 1
13+
14+
../src/tools/chip-cert/README
15+
../src/tools/spake2p/README
16+
17+
```
18+
19+
## Python tools
20+
21+
Source files for these tools are located at `scripts/tools`.
22+
23+
### General tools
24+
25+
```{toctree}
26+
:glob:
27+
:maxdepth: 1
28+
29+
../scripts/tools/memory/README
30+
../scripts/tools/spake2p/README
31+
32+
```
33+
34+
### NXP tools
35+
36+
```{toctree}
37+
:glob:
38+
:maxdepth: 1
39+
40+
../scripts/tools/nxp/factory_data_generator/README
41+
../scripts/tools/nxp/ota/README
42+
43+
```
44+
45+
### Silabs tools
46+
47+
```{toctree}
48+
:glob:
49+
:maxdepth: 1
50+
51+
../scripts/tools/silabs/README
52+
53+
```
54+
55+
### Telink tools
56+
57+
```{toctree}
58+
:glob:
59+
:maxdepth: 1
60+
61+
../scripts/tools/telink/readme
62+
63+
```

‎examples/contact-sensor-app/nxp/k32w/k32w0/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ The resulting output file can be found in out/debug/chip-k32w0x-contact-example.
241241
## Manufacturing data
242242
243243
See
244-
[Guide for writing manufacturing data on NXP devices](../../../../platform/nxp/doc/manufacturing_flow.md).
244+
[Guide for writing manufacturing data on NXP devices](../../../../../docs/guides/nxp_manufacturing_flow.md).
245245
246246
There are factory data generated binaries available in
247247
examples/platform/nxp/k32w/k32w0/scripts/demo_generated_factory_data folder.

‎examples/lighting-app/nxp/k32w/k32w0/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ The resulting output file can be found in out/debug/chip-k32w0x-light-example.
254254
## Manufacturing data
255255

256256
See
257-
[Guide for writing manufacturing data on NXP devices](../../../../platform/nxp/doc/manufacturing_flow.md).
257+
[Guide for writing manufacturing data on NXP devices](../../../../../docs/guides/nxp_manufacturing_flow.md).
258258

259259
There are factory data generated binaries available in
260260
examples/platform/nxp/k32w/k32w0/scripts/demo_generated_factory_data folder.

‎examples/lock-app/nxp/k32w/k32w0/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ The resulting output file can be found in out/debug/chip-k32w0x-lock-example.
227227
## Manufacturing data
228228

229229
See
230-
[Guide for writing manufacturing data on NXP devices](../../../../platform/nxp/doc/manufacturing_flow.md).
230+
[Guide for writing manufacturing data on NXP devices](../../../../../docs/guides/nxp_manufacturing_flow.md).
231231

232232
There are factory data generated binaries available in
233233
examples/platform/nxp/k32w/k32w0/scripts/demo_generated_factory_data folder.

‎scripts/tools/nxp/factory_data_generator/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
## NXP Factory Data Generator
1+
# NXP Factory Data Generator
22

33
For usage of the tool, please see
4-
[Guide for writing manufacturing data on NXP devices](../../../../examples/platform/nxp/doc/manufacturing_flow.md).
4+
[Guide for writing manufacturing data on NXP devices](../../../../docs/guides/nxp_manufacturing_flow.md).
55

66
## Tool implementation
77

‎scripts/tools/nxp/ota/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ private:
116116
update OTA image. If the `PAA` changes, make sure to generate the new
117117
certificates using the new `PAA` (which is only used by the controller, e.g.
118118
`chip-tool`). Please see the
119-
[manufacturing flow guide](../../../../examples/platform/nxp/doc/manufacturing_flow.md)
119+
[manufacturing flow guide](../../../../docs/guides/nxp_manufacturing_flow.md)
120120
for generating new certificates.
121121

122122
Example of OTA image generation with factory data and application update (using

‎scripts/tools/silabs/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#`FactoryDataProvider` for EFR32 Matter device
1+
# `FactoryDataProvider` for EFR32 Matter device
22

33
## Introduction
44

‎src/tools/chip-cert/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -809,7 +809,7 @@ HELP OPTIONS
809809
Print the version and then exit.
810810
```
811811

812-
#### gen-cd example
812+
#### print-cd example
813813

814814
An example of printing a Certificate Declaration (CD), which is provided as a
815815
command line argument in a hex format:

0 commit comments

Comments
 (0)