#317 Improve documentation for help

 * Add the default mapping.config location in the help text
 * Prompt users to use `--mapping` or `--mappig-file` if the requreid
field is not present

Signed-off-by: Chin Yeung Li <[email protected]>

Author: chinyeungli

src/attributecode/cmd.py

@@ -113,7 +113,7 @@ def cli():
     help='Set OUTPUT inventory file format.')
 
 @click.option('--mapping', is_flag=True,
-    help='Use file mapping.config to collect the defined not supported fields in ABOUT files.')
+    help='Use the default file mapping.config (./attributecode/mapping.config) with mapping between input keys and ABOUT field names.')
 
 @click.option('--mapping-file', metavar='FILE', nargs=1,
     type=click.Path(exists=True, dir_okay=True, readable=True, resolve_path=True),
@@ -197,7 +197,7 @@ def inventory(location, output, mapping, mapping_file, quiet, format, show_all):
     help="Copy the 'license_file' from the directory to the generated location.")
 
 @click.option('--mapping', is_flag=True,
-    help='Use the default file mapping.config with mapping between input keys and ABOUT field names.')
+    help='Use the default file mapping.config (./attributecode/mapping.config) with mapping between input keys and ABOUT field names.')
 
 @click.option('--mapping-file', metavar='FILE', nargs=1,
     type=click.Path(exists=True, dir_okay=True, readable=True, resolve_path=True),
@@ -271,8 +271,7 @@ def gen(location, output, mapping, mapping_file, license_notice_text_location, f
     )
 
 @click.option('--mapping', is_flag=True,
-    help='Use the file "mapping.config" with mappings between the CSV '
-        'inventory columns names and .ABOUT field names.')
+    help='Use the default file mapping.config (./attributecode/mapping.config) with mapping between input keys and ABOUT field names.')
 
 @click.option('--mapping-file', metavar='FILE', nargs=1,
     type=click.Path(exists=True, dir_okay=True, readable=True, resolve_path=True),

src/attributecode/gen.py

@@ -135,7 +135,12 @@ def load_inventory(location, base_dir, license_notice_text_location=None,
             errors.extend(dup_about_paths_err)
             return errors, abouts
     except:
-        msg = "The essential field 'about_file_path' is not found."
+        msg = (
+               "The essential field 'about_file_path' is not found.\n"
+               "Use the --mapping or --mapping-file option to map the "
+               "input keys and verify the mapping information are correct.\n"
+               "OR correct the column names in the <input>"
+               )
         errors.append(Error(CRITICAL, msg))
         return errors, abouts
 
@@ -147,8 +152,8 @@ def load_inventory(location, base_dir, license_notice_text_location=None,
             if f not in fields:
                 msg = (
                     "Required column: %(f)r not found.\n"
-                    "Use the --mapping option to map the input keys and verify the "
-                    "mapping information are correct.\n"
+                    "Use the --mapping or --mapping-file option to map the "
+                    "input keys and verify the mapping information are correct.\n"
                     "OR correct the column names in the <input>"
                 ) % locals()