From: Peter Krempa <pkrempa@redhat.com>
Date: Fri, 1 Mar 2024 22:01:54 +0000 (+0100)
Subject: vsh: Add '--dump-help' option for 'self-test' command
X-Git-Tag: v10.2.0-rc1~80
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7df38644bc8c7c16d17f52747eee13b0945596dd;p=thirdparty%2Flibvirt.git

vsh: Add '--dump-help' option for 'self-test' command

The new option dumps the full help outputs for every command so that
it's possible to conveniently check that subsequent refactors will not
impact any of the external functionality.

No man page entry is needed as the command is internal/undocumented.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>
---

diff --git a/tools/vsh.c b/tools/vsh.c
index 4f98f563f3..37a00e2065 100644
--- a/tools/vsh.c
+++ b/tools/vsh.c
@@ -3351,6 +3351,10 @@ const vshCmdOptDef opts_selftest[] = {
      .type = VSH_OT_BOOL,
      .help = N_("output the list of options which are missing completers")
     },
+    {.name = "dump-help",
+     .type = VSH_OT_BOOL,
+     .help = N_("output help for each command")
+    },
     {.name = NULL}
 };
 const vshCmdInfo info_selftest[] = {
@@ -3369,9 +3373,14 @@ cmdSelfTest(vshControl *ctl, const vshCmd *cmd)
     const vshCmdGrp *grp;
     const vshCmdDef *def;
     bool completers = vshCommandOptBool(cmd, "completers-missing");
+    bool dumphelp = vshCommandOptBool(cmd, "dump-help");
 
     for (grp = cmdGroups; grp->name; grp++) {
         for (def = grp->commands; def->name; def++) {
+
+            if (dumphelp && !def->alias)
+                vshCmddefHelp(def);
+
             if (vshCmddefCheckInternals(ctl, def, completers) < 0)
                 return false;
         }