Skip to content

Commit f13c16e

Browse files
0ciciMartin Havlik
authored andcommitted
docs: Update CN translation for NVS statistics example
1 parent ca16bf9 commit f13c16e

File tree

4 files changed

+23
-1
lines changed

4 files changed

+23
-1
lines changed

docs/en/api-reference/storage/nvs_flash.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ You can find code examples in the :example:`storage/nvs` directory of ESP-IDF ex
191191

192192
Default NVS partition is erased for a clean run of this example. Then mock data consisting of different NVS integer data types are written.
193193

194-
After that, iteration is performed over the individual data types, as well as the generic ``NVS_TYPE_ANY``, and relevant entry info gained from iteration is logged.
194+
After that, the example iterates over each individual data type as well as the generic ``NVS_TYPE_ANY`` type, and logs the information obtained from each iteration.
195195

196196
Internals
197197
---------

docs/zh_CN/api-guides/file-system-considerations.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,8 @@ NVS 具有如下特性:
190190

191191
- :example:`storage/nvs/nvs_rw_value` 演示了如何写入和读取一个整数值。
192192
- :example:`storage/nvs/nvs_rw_blob` 演示如何写入和读取一个 blob。
193+
- :example:`storage/nvs/nvs_statistics` 演示了如何获取并解读 NVS 使用情况统计信息:包括指定 NVS 分区中的空闲、已用、可用、总条目数、以及命名空间数量。
194+
- :example:`storage/nvs/nvs_iteration` 演示了如何遍历特定(或任意)NVS 数据类型的条目,以及如何获取这些条目的相关信息。
193195
- :example:`security/nvs_encryption_hmac` 演示了如何用 HMAC 外设进行 NVS 加密,并通过 efuse 中的 HMAC 密钥生成加密密钥。
194196
- :example:`security/flash_encryption` 演示了如何进行 flash 加密,包括创建和使用 NVS 分区。
195197

docs/zh_CN/api-reference/storage/index.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,10 @@
5353
- 演示了如何在 NVS flash 中使用 C 语言 API 读写整数数据类型。
5454
* - :example:`nvs_rw_value <storage/nvs/nvs_rw_value_cxx>`
5555
- 演示了如何在 NVS flash 中使用 C++ 语言 API 读写整数数据类型。
56+
* - :example:`nvs_statistics <storage/nvs/nvs_statistics>`
57+
- 演示了如何使用 C 风格 API 获取 NVS 使用情况统计信息,包括指定 NVS 分区中的空闲、已用、可用、总条目数、以及命名空间数量。
58+
* - :example:`nvs_iteration <storage/nvs/nvs_iteration>`
59+
- 演示了如何使用 C 风格 API 遍历特定(或任意)NVS 数据类型的条目,以及如何获取这些条目的相关信息。
5660
* - :example:`nvs_bootloader <storage/nvs/nvs_bootloader>`
5761
- 演示了如何使用引导加载程序代码中可用的 API 来读取 NVS 数据。
5862
* - :example:`nvsgen <storage/nvs/nvsgen>`

docs/zh_CN/api-reference/storage/nvs_flash.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,22 @@ ESP-IDF :example:`storage/nvs` 目录下提供了数个代码示例:
177177

178178
这个例子与 :example:`storage/nvs/nvs_rw_value` 完全一样,只是使用了 C++ 的 NVS 句柄类。
179179

180+
:example:`storage/nvs/nvs_statistics`
181+
182+
该示例演示了如何获取并解读 NVS 使用情况统计信息:包括指定 NVS 分区中的空闲、已用、可用、总条目数、以及命名空间数量。
183+
184+
默认的 NVS 分区会在运行本示例前被擦除,以确保干净的运行环境。随后,会写入模拟的字符串类型数据。
185+
186+
在写入数据前后分别获取使用情况统计信息,并将两者的差异与新占用条目的预期值进行比较。
187+
188+
:example:`storage/nvs/nvs_iteration`
189+
190+
该示例演示了如何遍历特定(或任意)NVS 数据类型的条目,以及如何获取这些条目的相关信息。
191+
192+
默认的 NVS 分区会在运行本示例前被擦除,以确保干净的运行环境。随后,会写入包含不同 NVS 整型数据类型的模拟数据。
193+
194+
之后,本示例会遍历各个数据类型以及通用的 ``NVS_TYPE_ANY`` 类型,并记录在每次遍历过程中获取到的信息。
195+
180196
内部实现
181197
---------
182198

0 commit comments

Comments
 (0)