]> granicus.if.org Git - esp-idf/commitdiff
util: Update docs as per review comments
authorShivani Tipnis <shivani@espressif.com>
Fri, 12 Oct 2018 04:46:39 +0000 (10:16 +0530)
committerShivani Tipnis <shivani@espressif.com>
Fri, 12 Oct 2018 05:34:49 +0000 (11:04 +0530)
components/nvs_flash/nvs_partition_generator/README.rst
components/nvs_flash/nvs_partition_generator/nvs_partition_gen.py
tools/mass_mfg/docs/README.rst
tools/mass_mfg/mfg_gen.py

index f0c6d66231fb1c33fb514478c2b65f36772794c0..bea753864a16ea9525aa668cffd19e20aa7fefe3 100644 (file)
@@ -116,6 +116,7 @@ A sample CSV file is provided with the utility::
 
     python nvs_partition_gen.py sample_singlepage_blob.csv partition_single_page.bin --version v1
 
+
 +------------------------+----------------------------------------------------------------------------------------------+
 |   Arguments            |                                     Description                                              |
 +========================+==============================================================================================+
@@ -123,7 +124,7 @@ A sample CSV file is provided with the utility::
 +------------------------+----------------------------------------------------------------------------------------------+
 | output                 | Path to output converted binary file. Will use stdout if omitted                             |
 +------------------------+----------------------------------------------------------------------------------------------+
-| size                   | Size of NVS Partition in hex (must be multiple of 4096). Eg. 0x1000                          |
+| size                   | Size of NVS Partition in bytes (must be multiple of 4096)                                    |
 +------------------------+----------------------------------------------------------------------------------------------+
 | --version {v1,v2}      |  Set version. Default: v2                                                                    |
 +-------------------------------+---------------------------------------------------------------------------------------+
index 2a01d0744717caf671012feee1ebd89a2119cdd9..416c146fc51d7b47bcb69f8ff8cc196c1d2f96cb 100755 (executable)
@@ -18,7 +18,7 @@
 # limitations under the License.
 #
 
-from __future__ import division, print_function #, unicode_literals
+from __future__ import division, print_function
 from builtins import int, range
 from io import open
 import sys
@@ -732,7 +732,7 @@ def main():
 
     parser.add_argument(
             "size",
-            help='Size of NVS Partition in hex (must be multiple of 4096). Eg. 0x1000')
+            help='Size of NVS Partition in bytes (must be multiple of 4096)')
 
     parser.add_argument(
             "--version",
index 8d50aedf845f9bfb12938bb6e4c7e4a3868db4ee..881fed6967cd2f111494090a605a27c848da5529 100644 (file)
@@ -120,7 +120,7 @@ The mfg\_gen.py utility is using the generated CSV Configuration file and Master
 +------------------------+----------------------------------------------------------------------------------------------+
 |   Arguments            |                                     Description                                              |                                   
 +========================+==============================================================================================+
-| --size PART_SIZE       |  Size of NVS Partition in hex (must be multiple of 4096). Eg. 0x1000                         |
+| --size PART_SIZE       |  Size of NVS Partition in bytes (must be multiple of 4096)                                   |
 +------------------------+----------------------------------------------------------------------------------------------+
 | --conf CONFIG_FILE     |  the input configuration csv file                                                            |
 +------------------------+----------------------------------------------------------------------------------------------+
index 07b2b28e68dc7956da446e840a589bc6e4b6fdc4..c5502161c0a6edb0d1e6563096b86fad084e6ba7 100755 (executable)
@@ -16,7 +16,7 @@
 #
 
 from __future__ import print_function
-from builtins import map, range
+from builtins import range
 from future.moves.itertools import zip_longest
 import sys
 import os
@@ -27,6 +27,7 @@ import distutils.dir_util
 sys.path.insert(0, os.getenv('IDF_PATH') + "/components/nvs_flash/nvs_partition_generator/")
 import nvs_partition_gen
 
+
 def verify_values_exist(input_values_file, keys_in_values_file):
     """ Verify all keys have corresponding values in values file
     """
@@ -288,7 +289,7 @@ file_identifier=None,output_dir_path=None):
             parser.add_argument("--size",
                                 dest='part_size',
                                 required=True,
-                                help='Size of NVS Partition in hex (must be multiple of 4096). Eg. 0x1000')
+                                help='Size of NVS Partition in bytes (must be multiple of 4096)')
 
             parser.add_argument('--conf',
                                 dest='config_file',