From 4a21a9e3419a6a4969d3bf1b11c1fa0331c4bdf0 Mon Sep 17 00:00:00 2001 From: Shivani Tipnis Date: Tue, 31 Aug 2021 18:36:24 +0530 Subject: [PATCH] nvs_tool: Update Readme with supports of multiline strings and comments in the CSV file Closes https://github.com/espressif/esp-idf/issues/7175 --- components/nvs_flash/nvs_partition_generator/README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/components/nvs_flash/nvs_partition_generator/README.rst b/components/nvs_flash/nvs_partition_generator/README.rst index 3a78a109d6..9ea5911200 100644 --- a/components/nvs_flash/nvs_partition_generator/README.rst +++ b/components/nvs_flash/nvs_partition_generator/README.rst @@ -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. -