alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Merge branch 'bugfix/fix_nvstool_readme' into 'master'

Browse Source 
Update Readme with supports of multiline strings and comments in the CSV file

Closes IDFGH-5434

See merge request espressif/esp-idf!15027
This commit is contained in:
Shivani Tipnis 2021-09-16 07:51:15 +00:00
commit 54e4aa9781
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
components/nvs_flash/nvs_partition_generator/README.rst
View File

@ -43,7 +43,7 @@ Each line of a .csv file should contain 4 parameters, separated by a comma. The
| | | | Any values in these cells are ignored. |
+-----+-----------+----------------------------------------------------------------------+-----------------------------------------------------+
.. note:: The first line of the CSV file should always be the column header and it is not configurable.
.. note:: The first line of the CSV file should be the column header and it is not configurable. Comments (if provided) are allowed only as the first line of the CSV file, the following line then should always be the column header. Comments should always start with the `#` symbol.
Below is an example dump of such a CSV file::
@ -308,5 +308,5 @@ Caveats
-------
- Utility does not check for duplicate keys and will write data pertaining to both keys. You need to make sure that the keys are distinct.
- Once a new page is created, no data will be written in the space left on the previous page. Fields in the CSV file need to be ordered in such a way as to optimize memory.
- Utility supports using multiline strings with ``file`` type and singleline strings with ``data`` type in the CSV file.
- 64-bit datatype is not yet supported.