Parcourir la source

util: Update docs as per review comments

Shivani Tipnis il y a 7 ans
Parent
commit
7c08fcccaf

+ 2 - 1
components/nvs_flash/nvs_partition_generator/README.rst

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

+ 2 - 2
components/nvs_flash/nvs_partition_generator/nvs_partition_gen.py

@@ -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",

+ 1 - 1
tools/mass_mfg/docs/README.rst

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

+ 3 - 2
tools/mass_mfg/mfg_gen.py

@@ -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',