Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

util: Update docs as per review comments

Browse source
This commit is contained in:
Shivani Tipnis 2018-10-12 10:16:39 +05:30
parent 5bee9faf49
commit 7c08fcccaf
4 changed files with 8 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
components/nvs_flash/nvs_partition_generator/README.rst
View 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 python nvs_partition_gen.py sample_singlepage_blob.csv partition_single_page.bin --version v1
+------------------------+----------------------------------------------------------------------------------------------+ +------------------------+----------------------------------------------------------------------------------------------+
| Arguments | Description | | 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 | | 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 | | --version {v1,v2} | Set version. Default: v2 |
+-------------------------------+---------------------------------------------------------------------------------------+ +-------------------------------+---------------------------------------------------------------------------------------+

4
components/nvs_flash/nvs_partition_generator/nvs_partition_gen.py
View file

@ -18,7 +18,7 @@
# limitations under the License. # limitations under the License.
# #
from __future__ import division, print_function #, unicode_literals from __future__ import division, print_function
from builtins import int, range from builtins import int, range
from io import open from io import open
import sys import sys
@ -732,7 +732,7 @@ def main():
parser.add_argument( parser.add_argument(
"size", "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( parser.add_argument(
"--version", "--version",

2
tools/mass_mfg/docs/README.rst
View file

@ -120,7 +120,7 @@ The mfg\_gen.py utility is using the generated CSV Configuration file and Master
+------------------------+----------------------------------------------------------------------------------------------+ +------------------------+----------------------------------------------------------------------------------------------+
| Arguments | Description | | 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 | | --conf CONFIG_FILE | the input configuration csv file |
+------------------------+----------------------------------------------------------------------------------------------+ +------------------------+----------------------------------------------------------------------------------------------+

5
tools/mass_mfg/mfg_gen.py
View file

@ -16,7 +16,7 @@
# #
from __future__ import print_function from __future__ import print_function
from builtins import map, range from builtins import range
from future.moves.itertools import zip_longest from future.moves.itertools import zip_longest
import sys import sys
import os import os
@ -27,6 +27,7 @@ import distutils.dir_util
sys.path.insert(0, os.getenv('IDF_PATH') + "/components/nvs_flash/nvs_partition_generator/") sys.path.insert(0, os.getenv('IDF_PATH') + "/components/nvs_flash/nvs_partition_generator/")
import nvs_partition_gen import nvs_partition_gen
def verify_values_exist(input_values_file, keys_in_values_file): def verify_values_exist(input_values_file, keys_in_values_file):
""" Verify all keys have corresponding values 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", parser.add_argument("--size",
dest='part_size', dest='part_size',
required=True, 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', parser.add_argument('--conf',
dest='config_file', dest='config_file',