From: Lennart Poettering <lennart@poettering.net>
Date: Wed, 28 Jun 2023 16:20:01 +0000 (+0200)
Subject: man: document vmm.notify_socket credential in systemd(1) man page
X-Git-Tag: v254-rc1~74
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=452cfd983f3394859bbd79924bd981d19471bb34;p=thirdparty%2Fsystemd.git

man: document vmm.notify_socket credential in systemd(1) man page

Let's move the long explanation to the man page of the component that
interprets the credential, and keep only a brief summary in
systemd.system-credentials(7).
---

diff --git a/man/systemd.system-credentials.xml b/man/systemd.system-credentials.xml
index 5be4ddfe59d..62f86d1254e 100644
--- a/man/systemd.system-credentials.xml
+++ b/man/systemd.system-credentials.xml
@@ -201,19 +201,13 @@
       <varlistentry>
         <term><varname>vmm.notify_socket</varname></term>
         <listitem>
-          <para>Contains a <constant>AF_VSOCK</constant> or <constant>AF_UNIX</constant> address where to
-          send a <constant>READY=1</constant> notification datagram when the system has finished booting. See
-          <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry> for
-          more information. Note that in case the hypervisor does not support <constant>SOCK_DGRAM</constant>
-          over <constant>AF_VSOCK</constant>, <constant>SOCK_SEQPACKET</constant> will be tried instead. The
-          credential payload for <constant>AF_VSOCK</constant> should be in the form
-          <literal>vsock:CID:PORT</literal>.</para>
-
-          <para>This feature is useful for hypervisors/VMMs or other processes on the host to receive a
-          notification via VSOCK when a virtual machine has finished booting.</para>
+          <para>Configures an
+          <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+          compatible <constant>AF_VSOCK</constant> socket the service manager will report status information,
+          ready notification and exit status on. For details see
+          <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
         </listitem>
       </varlistentry>
-
     </variablelist>
   </refsect1>
 
diff --git a/man/systemd.xml b/man/systemd.xml
index f1e0256e05f..3ceac5f9194 100644
--- a/man/systemd.xml
+++ b/man/systemd.xml
@@ -1048,6 +1048,30 @@
     <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>
   </refsect1>
 
+  <refsect1>
+    <title>System credentials</title>
+
+    <para>The service manager when run as PID 1 reads the following system credentials:</para>
+
+    <variablelist>
+      <varlistentry>
+        <term><varname>vmm.notify_socket</varname></term>
+        <listitem>
+          <para>Contains a <constant>AF_VSOCK</constant> or <constant>AF_UNIX</constant> address where to
+          send a <constant>READY=1</constant> notification datagram when the system has finished booting. See
+          <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry> for
+          more information. Note that in case the hypervisor does not support <constant>SOCK_DGRAM</constant>
+          over <constant>AF_VSOCK</constant>, <constant>SOCK_SEQPACKET</constant> will be tried instead. The
+          credential payload for <constant>AF_VSOCK</constant> should be in the form
+          <literal>vsock:CID:PORT</literal>.</para>
+
+          <para>This feature is useful for hypervisors/VMMs or other processes on the host to receive a
+          notification via VSOCK when a virtual machine has finished booting.</para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </refsect1>
+
   <refsect1>
     <title>Options</title>