commit 5c0fcf0f8725b98043a4b18f36e21489375d133a
author Mike Frysinger <vapier@chromium.org> Wed Jun 16 11:04:25 2021 -0400
committer Commit Bot <commit-bot@chromium.org> Sat Jun 26 05:43:42 2021 +0000
tree 3bb07f6afc46a008c0dc9d3ae3f64b9b3273004c
parent 600c679cd66265a54ee63b1747abfff6f94a25ad

crossystem: update --help text

Fix styling of earlier sections and link to the CrOS os_config guide.

BUG=None
TEST=`crossystem --help` looks nice
BRANCH=None

Signed-off-by: Mike Frysinger <vapier@chromium.org>
Change-Id: I1d5d9b080ee288541619ec4e0e8d550985051558
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/vboot_reference/+/2966239
Reviewed-by: Julius Werner <jwerner@chromium.org>

utility/crossystem.c

diff --git a/utility/crossystem.c b/utility/crossystem.c
index 8fdce98..079bf32 100644
--- a/utility/crossystem.c
+++ b/utility/crossystem.c
@@ -106,7 +106,7 @@
 static void PrintHelp(const char *progname) {
   const Param *p;
 
-  printf("\nUsage:\n"
+  printf("Usage:\n"
          "  %s [--all]\n"
          "    Prints all parameters with descriptions and current values.\n"
          "    If --all is specified, prints even normally hidden fields.\n"
@@ -116,7 +116,7 @@
          "    Sets the parameter(s) to the specified value(s).\n"
          "  %s [param1?value1] [param2?value2 [...]]]\n"
          "    Checks if the parameter(s) all contain the specified value(s).\n"
-         "Stops at the first error."
+         "    Stops at the first error.\n"
          "\n"
          "Valid parameters:\n", progname, progname, progname, progname);
   for (p = sys_param_list; p->name; p++) {
@@ -125,6 +125,10 @@
            (p->flags & IS_STRING) ? "str" : "int",
            p->desc);
   }
+  printf("\n"
+         "For more information, please see:\n"
+         "https://chromium.googlesource.com/chromiumos/docs/+/HEAD/"
+         "os_config.md#crossystem\n");
 }