feedc0de/esp-idf
1
0
Fork 0
forked from espressif/esp-idf
Code Pull Requests Activity

Merge branch 'bugfix/nvs_docs_build' into 'master'

Browse Source 
docs: fix nvs-related docs build issue

See merge request espressif/esp-idf!21917
This commit is contained in:
Marius Vikhammer
2023-01-06 13:18:35 +08:00
parent aa05964412 7f0aa7b534
commit c55d82d1fa
5 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.gitlab/ci/docs.yml
View File

@@ -5,6 +5,7 @@
- "components/**/Kconfig*" - "components/**/Kconfig*"
- "components/**/CMakeList.txt" - "components/**/CMakeList.txt"
- "components/**/sdkconfig*" - "components/**/sdkconfig*"
- "**/*.rst"
- "tools/tools.json" - "tools/tools.json"
- "tools/idf_tools.py" - "tools/idf_tools.py"
- "CONTRIBUTING.rst" - "CONTRIBUTING.rst"

2
components/nvs_flash/nvs_partition_tool/README.rst
View File

@@ -6,7 +6,7 @@ NVS Partition Parser Utility
Introduction Introduction
------------ ------------
The utility :component_file:`nvs_flash/nvs_partition_parser/nvs_tool.py` loads and parses an NVS storage partition for easier debugging and data extraction. The utility also features integrity check which scans the partition for potential errors. Data blobs are encoded in `base64` format. The utility :component_file:`nvs_flash/nvs_partition_tool/nvs_tool.py` loads and parses an NVS storage partition for easier debugging and data extraction. The utility also features integrity check which scans the partition for potential errors. Data blobs are encoded in `base64` format.
Encrypted Partitions Encrypted Partitions
-------------------- --------------------

2
components/nvs_flash/nvs_partition_tool/README_CN.rst
View File

@@ -6,7 +6,7 @@ NVS 分区解析程序
介绍 介绍
------- -------
NVS 分区解析程序 :component_file:`nvs_flash/nvs_partition_parser/nvs_read.py` 加载并解析 NVS 存储分区，以便于调试和数据提取。该程序还支持完整性检查功能，可扫描分区中可能存在的错误。Blob 数据以 `base64` 格式进行编码。 NVS 分区解析程序 :component_file:`nvs_flash/nvs_partition_tool/nvs_tool.py` 加载并解析 NVS 存储分区，以便于调试和数据提取。该程序还支持完整性检查功能，可扫描分区中可能存在的错误。Blob 数据以 `base64` 格式进行编码。
加密分区 加密分区
----------- -----------

2
docs/en/api-reference/storage/nvs_partition_parse.rst
View File

@@ -1 +1 @@
.. include:: /../../components/nvs_flash/nvs_partition_parser/README.rst .. include:: /../../components/nvs_flash/nvs_partition_tool/README.rst

2
docs/zh_CN/api-reference/storage/nvs_partition_parse.rst
View File

@@ -1 +1 @@
.. include:: /../../components/nvs_flash/nvs_partition_parser/README_CN.rst .. include:: /../../components/nvs_flash/nvs_partition_tool/README_CN.rst