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

docs: Refactor table for nvs_create_partition_image arguments

Browse Source
This commit is contained in:
Adam Múdry
2023-08-03 15:10:33 +02:00
parent d975a26666
commit 5e5220a77c
1 changed files with 26 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
docs/en/api-reference/storage/nvs_flash.rst
View File

@@ -98,29 +98,35 @@ Instead of calling the ``nvs_partition_gen.py`` tool manually, the creation of t
**Positional Arguments**:
+---------------+---------------------------------------------------------------+
| Parameter | Description |
+===============+===============================================================+
| ``partition`` | Name of the NVS parition |
+---------------+---------------------------------------------------------------+
| ``csv`` | Path to CSV file to parse |
+---------------+---------------------------------------------------------------+
.. list-table::
:header-rows: 1
* - Parameter
- Description
* - ``partition``
- Name of the NVS parition
* - ``csv``
- Path to CSV file to parse
**Optional Arguments**:
+----------------------+----------------------------------------------------------------------+
| Parameter | Description |
+======================+======================================================================+
| ``FLASH_IN_PROJECT`` | Flash the image when using ``idf.py flash`` |
+----------------------+----------------------------------------------------------------------+
| ``VERSION`` | Set multipage blob version (Default: Version 2) |
| | |
| | Version 1 - Multipage blob support disabled |
| | |
| | Version 2 - Multipage blob support enabled |
+----------------------+----------------------------------------------------------------------+
| ``DEPENDS`` | Specify files on which the command depends |
+----------------------+----------------------------------------------------------------------+
.. list-table::
:header-rows: 1
* - Parameter
- Description
* - ``FLASH_IN_PROJECT``
- Name of the NVS parition
* - ``VERSION {1,2}``
- Set multipage blob version (Default: Version 2)
Version 1 = support disabled
Version 2 = support enabled
* - ``DEPENDS``
- Specify files on which the command depends
If FLASH_IN_PROJECT is not specified, the image will still be generated, but you will have to flash it manually using ``idf.py <partition>-flash`` (e.g. if your parition name is ``nvs`` ``idf.py nvs-flash``).