From 42e4ac0b7b4febf92b9ed4be85fac4e5129c8e84 Mon Sep 17 00:00:00 2001 From: Jack Rosenthal Date: Tue, 30 Nov 2021 12:35:29 -0700 Subject: zephyr: zmake: Add help strings for all subcommands Add a brief description of each subcommand so that "zmake --help" tells you what each command does. BUG=none BRANCH=none TEST=observe output of "zmake --help" Signed-off-by: Jack Rosenthal Change-Id: If787e5e519f5ab1d2f1189798438aa2b84cfe19c Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3309361 Reviewed-by: Jeremy Bettis --- zephyr/zmake/zmake/__main__.py | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/zephyr/zmake/zmake/__main__.py b/zephyr/zmake/zmake/__main__.py index 558ca23555..f283bc00ea 100644 --- a/zephyr/zmake/zmake/__main__.py +++ b/zephyr/zmake/zmake/__main__.py @@ -165,7 +165,10 @@ def main(argv=None): sub = parser.add_subparsers(dest="subcommand", help="Subcommand") sub.required = True - configure = sub.add_parser("configure") + configure = sub.add_parser( + "configure", + help="Set up a build directory to be built later by the build subcommand", + ) configure.add_argument("-t", "--toolchain", help="Name of toolchain to use") configure.add_argument( "--bringup", @@ -207,7 +210,10 @@ def main(argv=None): help="Enable CONFIG_COVERAGE Kconfig.", ) - build = sub.add_parser("build") + build = sub.add_parser( + "build", + help="Execute the build from a build directory", + ) build.add_argument( "build_dir", type=pathlib.Path, @@ -239,16 +245,25 @@ def main(argv=None): help="Optional directory to search for BUILD.py files in.", ) - test = sub.add_parser("test") + test = sub.add_parser( + "test", + help="Execute tests from a build directory", + ) test.add_argument( "build_dir", type=pathlib.Path, help="The build directory used during configuration", ) - sub.add_parser("testall") + sub.add_parser( + "testall", + help="Execute all known builds and tests", + ) - coverage = sub.add_parser("coverage") + coverage = sub.add_parser( + "coverage", + help="Run coverage on a build directory", + ) coverage.add_argument( "build_dir", type=pathlib.Path, -- cgit v1.2.1