From bdd36c003d9c4c4ca89c92be504615378f61513c Mon Sep 17 00:00:00 2001
From: Daan De Meyer <daan.j.demeyer@gmail.com>
Date: Mon, 23 Oct 2023 11:18:35 +0200
Subject: kernel-install: Add --json option for inspect verb

In mkosi, we can't use kernel-install directly but we do want to
mimick its behavior as much as possible. Let's make that easier by
making it easy to fetch data from kernel-install as JSON.

To get all the necessary data, we extend the inspect verb to also
allow passing in a kernel version and initrds, to mimick the "add"
verb. The kernel version is used to determine the "Entry Directory",
and in absence of auto-detection of kernel version in kernel-install
we have to allow users to pass it.

We also add --no-pager while we're at it.
---
 man/kernel-install.xml | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

(limited to 'man')

diff --git a/man/kernel-install.xml b/man/kernel-install.xml
index 64137ce61c..822c289259 100644
--- a/man/kernel-install.xml
+++ b/man/kernel-install.xml
@@ -40,7 +40,9 @@
       <command>kernel-install</command>
       <arg choice="opt" rep="repeat">OPTIONS</arg>
       <arg choice="plain">inspect</arg>
+      <arg choice="opt"><replaceable>KERNEL-VERSION</replaceable></arg>
       <arg choice="opt"><replaceable>KERNEL-IMAGE</replaceable></arg>
+      <arg choice="opt" rep="repeat"><replaceable>INITRD-FILE</replaceable></arg>
     </cmdsynopsis>
   </refsynopsisdiv>
 
@@ -176,11 +178,14 @@
         </listitem>
       </varlistentry>
       <varlistentry>
-        <term><command>inspect [<replaceable>KERNEL-IMAGE</replaceable>]</command></term>
+        <term>
+          <command>inspect [[<replaceable>KERNEL-VERSION</replaceable>] <replaceable>KERNEL-IMAGE</replaceable>] [<replaceable>INITRD-FILE</replaceable> ...]</command>
+        </term>
         <listitem>
           <para>Shows the various paths and parameters configured or auto-detected. In particular shows the
           values of the various <varname>$KERNEL_INSTALL_*</varname> environment variables listed
-          below.</para>
+          below. The <option>--json</option> option can be used to get the output of this verb as a JSON
+          object.</para>
 
           <xi:include href="version-info.xml" xpointer="v251"/>
         </listitem>
@@ -298,6 +303,8 @@
 
       <xi:include href="standard-options.xml" xpointer="help" />
       <xi:include href="standard-options.xml" xpointer="version" />
+      <xi:include href="standard-options.xml" xpointer="no-pager"/>
+      <xi:include href="standard-options.xml" xpointer="json" />
     </variablelist>
   </refsect1>
 
-- 
cgit v1.2.3