From ba3e55f8d961b8ba3e613d158f879cdefce984af Mon Sep 17 00:00:00 2001
From: Lars Wirzenius <liw@liw.fi>
Date: Sat, 27 May 2023 13:41:22 +0300
Subject: docs: make --help output more helpuful

Sponsored-by: author
---
 v-i | 33 ++++++++++++++++++++++++---------
 1 file changed, 24 insertions(+), 9 deletions(-)

(limited to 'v-i')

diff --git a/v-i b/v-i
index c140089..31286d4 100755
--- a/v-i
+++ b/v-i
@@ -252,7 +252,7 @@ def grub(device, root, efi):
     }
 
 
-def vmdb_spec(system, ansible_vars):
+def vmdb_spec(system, ansible_vars, std_yml):
     device = "{{ image }}"
     steps = [
         # Create partition table.
@@ -277,11 +277,11 @@ def vmdb_spec(system, ansible_vars):
                 cryptsetup("cryptsetup0", system.luks, "pv0"),
             ]
         )
-        for (i, drive) in enumerate(system.extra_drives):
+        for i, drive in enumerate(system.extra_drives):
             steps.append(cryptsetup(f"cryptsetuo{i+1}", system.luks, f"pv{i+1}"))
     else:
         steps.append(mkpart(device, "pv0", "1G", "100%"))
-        for (i, drive) in enumerate(system.extra_drives):
+        for i, drive in enumerate(system.extra_drives):
             steps.extend(
                 [
                     mklabel(drive),
@@ -373,7 +373,7 @@ def vmdb_spec(system, ansible_vars):
     )
 
     # If playbooks have been specified, add ansible steps.
-    for p in ["std.yml"] + system.extra_playbooks:
+    for p in [std_yml] + system.extra_playbooks:
         if p:
             steps.append({"ansible": "root", "playbook": p, "extra_vars": ansible_vars})
 
@@ -470,10 +470,25 @@ def main():
     timings = Timings()
 
     p = argparse.ArgumentParser()
-    p.add_argument("--verbose", action="store_true")
-    p.add_argument("--very-verbose", action="store_true")
-    p.add_argument("--log", default="install.log")
-    p.add_argument("--cache", default=None)
+    p.add_argument(
+        "--verbose", action="store_true", help="report to stdout what's happening"
+    )
+    p.add_argument(
+        "--very-verbose", action="store_true", help="be more verbose to stdout"
+    )
+    p.add_argument(
+        "--log", default="install.log", help="log to file LOG (default is no log file)"
+    )
+    p.add_argument(
+        "--cache",
+        default=None,
+        help="use CACHE to cache debootstrap output (default is computed from spec file content)",
+    )
+    p.add_argument(
+        "--std-yml",
+        default="/usr/share/v-i/std.yml",
+        help="Ansible playbook for standard system (%(default)s)",
+    )
     p.add_argument("spec")
     args = p.parse_args()
 
@@ -507,7 +522,7 @@ def main():
     clean_up_disks([system.drive] + system.extra_drives)
     timings.reached("clean up storage")
 
-    vmdb = vmdb_spec(system, ansible_vars)
+    vmdb = vmdb_spec(system, ansible_vars, args.std_yml)
     tmp = tempfile.mkdtemp()
     specfile = os.path.join(tmp, "spec.yaml")
     if args.very_verbose:
-- 
cgit v1.2.1