mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
Docs: Add CN translation for nvs_partition_parser/README.rst
This commit is contained in:
parent
1c6edff560
commit
ec680a2a82
@ -1,28 +1,29 @@
|
||||
NVS Partition Parser Utility
|
||||
============================
|
||||
|
||||
:link_to_translation:`zh_CN:[中文]`
|
||||
|
||||
Introduction
|
||||
------------
|
||||
|
||||
The utility :component_file:`nvs_flash/nvs_partition_parser/nvs_read.py` loads and parses an NVS storage partition for easier debugging / data extraction.
|
||||
The utility also has an integrity check feature which scans the partition for potential errors.
|
||||
The utility :component_file:`nvs_flash/nvs_partition_parser/nvs_read.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.
|
||||
|
||||
Encrypted partitions
|
||||
Encrypted Partitions
|
||||
--------------------
|
||||
|
||||
This utility doesn't support decryption. To decrypt the NVS partition use the :doc:`NVS Partition Generator Utility </api-reference/storage/nvs_partition_gen>` which does support NVS partition encryption/decryption.
|
||||
This utility does not support decryption. To decrypt the NVS partition, please use the :doc:`NVS Partition Generator Utility </api-reference/storage/nvs_partition_gen>` which does support NVS partition encryption and decryption.
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
The utility provides 6 different output styles with `-d` or `--dump` option:
|
||||
- `all` (default) - Prints all entries with metadata
|
||||
- `written` - Prints only written entries with metadata
|
||||
- `minimal` - Prints written `namespace:key = value` pairs
|
||||
The utility provides six different output styles with `-d` or `--dump` option:
|
||||
- `all` (default) - Prints all entries with metadata.
|
||||
- `written` - Prints only written entries with metadata.
|
||||
- `minimal` - Prints written `namespace:key = value` pairs.
|
||||
- `namespaces` - Prints all written namespaces
|
||||
- `blobs` - Prints all blobs & strings (reconstructs them if they are chunked)
|
||||
- `storage_info` - Prints entry states count for every page
|
||||
- `blobs` - Prints all blobs and strings (reconstructs them if they are chunked).
|
||||
- `storage_info` - Prints entry states count for every page.
|
||||
|
||||
.. note:: There is also `none` option which will not print anything. This can be used with the integrity check option if the contents of NVS partition are not relevant.
|
||||
.. note:: There is also a `none` option which will not print anything. This can be used with the integrity check option if the NVS partition contents are irrelevant.
|
||||
|
||||
The utility also provides an integrity check feature via `-i` or `--integrity-check` option. This option scans through the entire partition and prints potential errors. This option can be used with '-d none' option which will print only the potential errors.
|
||||
The utility also provides an integrity check feature via the `-i` or `--integrity-check` option. This feature scans through the entire partition and prints potential errors. It can be used with the `-d none` option which will print only the potential errors.
|
||||
|
@ -0,0 +1,29 @@
|
||||
NVS 分区解析程序
|
||||
======================
|
||||
|
||||
:link_to_translation:`en:[English]`
|
||||
|
||||
介绍
|
||||
-------
|
||||
|
||||
NVS 分区解析程序 :component_file:`nvs_flash/nvs_partition_parser/nvs_read.py` 加载并解析 NVS 存储分区,以便于调试和数据提取。该程序还支持完整性检查功能,可扫描分区中可能存在的错误。
|
||||
|
||||
加密分区
|
||||
-----------
|
||||
|
||||
此程序不支持解密。如需解密 NVS 分区,请使用 :doc:`NVS 分区生成程序 </api-reference/storage/nvs_partition_gen>`。该工具支持 NVS 分区加解密。
|
||||
|
||||
使用方法
|
||||
-----------
|
||||
|
||||
该程序通过 `-d` 或 `-dump` 选项提供了六种不同的输出方式:
|
||||
- `all` (默认) - 打印所有带有元数据的条目。
|
||||
- `written` - 只打印带有元数据的写入条目。
|
||||
- `minimal` - 打印写入的 `namespace:key = value` 对。
|
||||
- `namespaces` - 打印所有写入的命名空间。
|
||||
- `blobs` - 打印所有 blob 和字符串(若 blob 和字符串是以分块的形式,则对其进行重组)。
|
||||
- `storage_info` - 打印每一页面的条目状态计数。
|
||||
|
||||
.. 注意:: 该程序还提供 `none` 选项,该选项不会打印任何东西。如果 NVS 分区的内容并不相关,可以将该选项和完整性检查选项一起使用。
|
||||
|
||||
该程序支持完整性检查功能,选择选项 `-i` 或 `--integrity-check` 即可运行。此功能可扫描整个分区,并打印出可能存在的错误。当此功能和 `-d none` 一起使用时,可只打印可能存在的错误。
|
Loading…
Reference in New Issue
Block a user