|
|
@@ -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.
|