]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
man: document vmm.notify_socket credential in systemd(1) man page
authorLennart Poettering <lennart@poettering.net>
Wed, 28 Jun 2023 16:20:01 +0000 (18:20 +0200)
committerLuca Boccassi <luca.boccassi@gmail.com>
Thu, 29 Jun 2023 21:11:41 +0000 (22:11 +0100)
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).

man/systemd.system-credentials.xml
man/systemd.xml

index 5be4ddfe59d987e6338571a1836ab0a6ac35916e..62f86d1254e7613393e88c2ae26f1cc3b7a4cc6d 100644 (file)
       <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>
 
index f1e0256e05f681e21750156bd7b7051018eb9534..3ceac5f9194599c6ebc5b2c8fc9e9a9941579a23 100644 (file)
     <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>