SymbX/systemd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source 
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).
This commit is contained in:
Lennart Poettering
2023-06-29 22:11:41 +01:00
committed by Luca Boccassi
parent 49bf8bd57a
commit 452cfd983f
2 changed files with 29 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
man/systemd.system-credentials.xml
+5 -11
View File
@@ -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>
man/systemd.xml
+24
View File
@@ -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>