twister: coverage: Group command line arguments

Group Twister code coverage command line arguments for better usability.
Add more details in descriptions.

Signed-off-by: Dmitrii Golovanov <[email protected]>

Author: golowanow

scripts/pylib/twister/twisterlib/environment.py

@@ -114,6 +114,12 @@ def add_parse_arguments(parser = None) -> argparse.ArgumentParser:
        title="Memory footprint",
        description="Collect and report ROM/RAM size footprint for the test instance images built.")
 
+    coverage_group = parser.add_argument_group(
+        title="Code coverage",
+        description="Build with code coverage support, collect code coverage statistics "
+                    "executing tests, compose code coverage report at the end.\n"
+                    "Effective for devices with 'HAS_COVERAGE_SUPPORT'.")
+
     test_plan_report_xor.add_argument(
         "-E",
         "--save-tests",
@@ -342,10 +348,6 @@ def add_parse_arguments(parser = None) -> argparse.ArgumentParser:
                 If not provided, seed in generated by system.
                 Used only when --shuffle-tests is provided.""")
 
-    parser.add_argument("-C", "--coverage", action="store_true",
-                        help="Generate coverage reports. Implies "
-                             "--enable-coverage.")
-
     parser.add_argument(
         "-c", "--clobber-output", action="store_true",
         help="Cleaning the output directory will simply delete it instead "
@@ -355,27 +357,38 @@ def add_parse_arguments(parser = None) -> argparse.ArgumentParser:
         "--cmake-only", action="store_true",
         help="Only run cmake, do not build or run.")
 
-    parser.add_argument("--coverage-basedir", default=ZEPHYR_BASE,
-                        help="Base source directory for coverage report.")
+    coverage_group.add_argument("--enable-coverage", action="store_true",
+                     help="Enable code coverage collection using gcov.")
 
-    parser.add_argument("--coverage-platform", action="append", default=[],
-                        help="Platforms to run coverage reports on. "
-                             "This option may be used multiple times. "
-                             "Default to what was selected with --platform.")
+    coverage_group.add_argument("-C", "--coverage", action="store_true",
+                     help="Generate coverage reports. Implies "
+                          "--enable-coverage to collect the coverage data first.")
 
-    parser.add_argument("--coverage-tool", choices=['lcov', 'gcovr'], default='gcovr',
-                        help="Tool to use to generate coverage report.")
+    coverage_group.add_argument("--gcov-tool", type=Path, default=None,
+                     help="Path to the 'gcov' tool to use for code coverage reports. "
+                          "By default it will be chosen in the following order:"
+                          " using ZEPHYR_TOOLCHAIN_VARIANT ('llvm': from LLVM_TOOLCHAIN_PATH),"
+                          " gcov installed on the host - for 'native' or 'unit' platform types,"
+                          " using ZEPHYR_SDK_INSTALL_DIR.")
 
-    parser.add_argument(
-        "--coverage-formats",
-        action="store",
-        default=None, # default behavior is set in run_coverage
-        help="Output formats to use for generated coverage reports, as a comma-separated list. " +
-             "Valid options for 'gcovr' tool are: " +
-             ','.join(supported_coverage_formats['gcovr']) + " (html - default)." +
-             " Valid options for 'lcov' tool are: " +
-             ','.join(supported_coverage_formats['lcov']) + " (html,lcov - default)."
-        )
+    coverage_group.add_argument("--coverage-basedir", default=ZEPHYR_BASE,
+                    help="Base source directory for coverage report.")
+
+    coverage_group.add_argument("--coverage-platform", action="append", default=[],
+                    help="Platforms to run coverage reports on. "
+                         "This option may be used multiple times. "
+                         "Default to what was selected with --platform.")
+
+    coverage_group.add_argument("--coverage-tool", choices=['lcov', 'gcovr'], default='gcovr',
+                    help="Tool to use to generate coverage report (%(default)s - default).")
+
+    coverage_group.add_argument("--coverage-formats", action="store", default=None,
+                    help="Output formats to use for generated coverage reports " +
+                         "as a comma-separated list without spaces. " +
+                         "Valid options for 'gcovr' tool are: " +
+                         ','.join(supported_coverage_formats['gcovr']) + " (html - default)." +
+                         " Valid options for 'lcov' tool are: " +
+                         ','.join(supported_coverage_formats['lcov']) + " (html,lcov - default).")
 
     parser.add_argument(
         "--test-config",
@@ -402,9 +415,6 @@ def add_parse_arguments(parser = None) -> argparse.ArgumentParser:
                         help="Specify tags of tests that should not run. "
                              "Default is to run all tests with all tags.")
 
-    parser.add_argument("--enable-coverage", action="store_true",
-                        help="Enable code coverage using gcov.")
-
     parser.add_argument(
         "--enable-lsan", action="store_true",
         help="""Enable leak sanitizer to check for heap memory leaks.
@@ -437,10 +447,6 @@ def add_parse_arguments(parser = None) -> argparse.ArgumentParser:
                         help="Do not filter based on toolchain, use the set "
                              " toolchain unconditionally")
 
-    parser.add_argument("--gcov-tool", type=Path, default=None,
-                        help="Path to the gcov tool to use for code coverage "
-                             "reports")
-
     footprint_group.add_argument(
         "--create-rom-ram-report",
         action="store_true",