From 61c5fc21e1e790169f64e7c058cc27fde507ae19 Mon Sep 17 00:00:00 2001 From: Ivan Grokhotkov Date: Thu, 5 Jan 2023 09:16:12 +0100 Subject: [PATCH 1/2] docs: fix nvs-related docs build issue --- .gitlab/ci/docs.yml | 1 + components/nvs_flash/nvs_partition_tool/README.rst | 2 +- components/nvs_flash/nvs_partition_tool/README_CN.rst | 2 +- docs/en/api-reference/storage/nvs_partition_parse.rst | 2 +- docs/zh_CN/api-reference/storage/nvs_partition_parse.rst | 2 +- 5 files changed, 5 insertions(+), 4 deletions(-) diff --git a/.gitlab/ci/docs.yml b/.gitlab/ci/docs.yml index 46c82d5551..a4e26a10c3 100644 --- a/.gitlab/ci/docs.yml +++ b/.gitlab/ci/docs.yml @@ -5,6 +5,7 @@ - "components/**/Kconfig*" - "components/**/CMakeList.txt" - "components/**/sdkconfig*" + - "**/*.rst" - "tools/tools.json" - "tools/idf_tools.py" - "CONTRIBUTING.rst" diff --git a/components/nvs_flash/nvs_partition_tool/README.rst b/components/nvs_flash/nvs_partition_tool/README.rst index ddf6e1a73b..9548cefa56 100644 --- a/components/nvs_flash/nvs_partition_tool/README.rst +++ b/components/nvs_flash/nvs_partition_tool/README.rst @@ -6,7 +6,7 @@ NVS Partition Parser Utility 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 -------------------- diff --git a/components/nvs_flash/nvs_partition_tool/README_CN.rst b/components/nvs_flash/nvs_partition_tool/README_CN.rst index 790d4a37e8..6edc657daf 100644 --- a/components/nvs_flash/nvs_partition_tool/README_CN.rst +++ b/components/nvs_flash/nvs_partition_tool/README_CN.rst @@ -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_read.py` 加载并解析 NVS 存储分区，以便于调试和数据提取。该程序还支持完整性检查功能，可扫描分区中可能存在的错误。Blob 数据以 `base64` 格式进行编码。 加密分区 ----------- diff --git a/docs/en/api-reference/storage/nvs_partition_parse.rst b/docs/en/api-reference/storage/nvs_partition_parse.rst index 01a481fc9b..7850861f60 100644 --- a/docs/en/api-reference/storage/nvs_partition_parse.rst +++ b/docs/en/api-reference/storage/nvs_partition_parse.rst @@ -1 +1 @@ -.. include:: /../../components/nvs_flash/nvs_partition_parser/README.rst +.. include:: /../../components/nvs_flash/nvs_partition_tool/README.rst diff --git a/docs/zh_CN/api-reference/storage/nvs_partition_parse.rst b/docs/zh_CN/api-reference/storage/nvs_partition_parse.rst index fb4477b66a..b2b7d9990d 100644 --- a/docs/zh_CN/api-reference/storage/nvs_partition_parse.rst +++ b/docs/zh_CN/api-reference/storage/nvs_partition_parse.rst @@ -1 +1 @@ -.. include:: /../../components/nvs_flash/nvs_partition_parser/README_CN.rst +.. include:: /../../components/nvs_flash/nvs_partition_tool/README_CN.rst From 7f0aa7b534ddcd9e3505494171654b00bcb00545 Mon Sep 17 00:00:00 2001 From: Marius Vikhammer Date: Fri, 6 Jan 2023 11:00:17 +0800 Subject: [PATCH 2/2] docs: updated path to nvs_tool.py in chinese doc. --- components/nvs_flash/nvs_partition_tool/README_CN.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/components/nvs_flash/nvs_partition_tool/README_CN.rst b/components/nvs_flash/nvs_partition_tool/README_CN.rst index 6edc657daf..bdbede7e6e 100644 --- a/components/nvs_flash/nvs_partition_tool/README_CN.rst +++ b/components/nvs_flash/nvs_partition_tool/README_CN.rst @@ -6,7 +6,7 @@ NVS 分区解析程序 介绍 ------- -NVS 分区解析程序 :component_file:`nvs_flash/nvs_partition_tool/nvs_read.py` 加载并解析 NVS 存储分区，以便于调试和数据提取。该程序还支持完整性检查功能，可扫描分区中可能存在的错误。Blob 数据以 `base64` 格式进行编码。 +NVS 分区解析程序 :component_file:`nvs_flash/nvs_partition_tool/nvs_tool.py` 加载并解析 NVS 存储分区，以便于调试和数据提取。该程序还支持完整性检查功能，可扫描分区中可能存在的错误。Blob 数据以 `base64` 格式进行编码。 加密分区 -----------