diff options
author | Lennart Poettering <lennart@poettering.net> | 2023-01-02 18:13:27 +0100 |
---|---|---|
committer | Lennart Poettering <lennart@poettering.net> | 2023-01-10 18:28:38 +0100 |
commit | 81e19b6f6585d656e972efad73781e184ca0e7a0 (patch) | |
tree | f0fc8b8f051c116873723fde9f2b1603c48f996d /man/sd_notify.xml | |
parent | 3bd28bf721dc70722ff1c675026ed0b44ad968a3 (diff) | |
download | systemd-81e19b6f6585d656e972efad73781e184ca0e7a0.tar.gz |
man: document Type=notify-reload
Diffstat (limited to 'man/sd_notify.xml')
-rw-r--r-- | man/sd_notify.xml | 36 |
1 files changed, 24 insertions, 12 deletions
diff --git a/man/sd_notify.xml b/man/sd_notify.xml index 021cd0384f..0ba191c0ce 100644 --- a/man/sd_notify.xml +++ b/man/sd_notify.xml @@ -102,23 +102,35 @@ <varlistentry> <term>READY=1</term> - <listitem><para>Tells the service manager that service startup is finished, or the service finished loading its - configuration. This is only used by systemd if the service definition file has <varname>Type=notify</varname> - set. Since there is little value in signaling non-readiness, the only value services should send is - <literal>READY=1</literal> (i.e. <literal>READY=0</literal> is not defined).</para></listitem> + <listitem><para>Tells the service manager that service startup is finished, or the service finished + re-loading its configuration. This is only used by systemd if the service definition file has + <varname>Type=notify</varname> or <varname>Type=notify-reload</varname> set. Since there is little + value in signaling non-readiness, the only value services should send is <literal>READY=1</literal> + (i.e. <literal>READY=0</literal> is not defined).</para></listitem> </varlistentry> <varlistentry> <term>RELOADING=1</term> - <listitem><para>Tells the service manager that the service is - reloading its configuration. This is useful to allow the - service manager to track the service's internal state, and - present it to the user. Note that a service that sends this - notification must also send a <literal>READY=1</literal> - notification when it completed reloading its - configuration. Reloads are propagated in the same way as they - are when initiated by the user.</para></listitem> + <listitem><para>Tells the service manager that the service is beginning to reload its + configuration. This is useful to allow the service manager to track the service's internal state, and + present it to the user. Note that a service that sends this notification must also send a + <literal>READY=1</literal> notification when it completed reloading its configuration. Reloads the + service manager is notified about with this mechanisms are propagated in the same way as they are + when originally initiated through the service manager. This message is particularly relevant for + <varname>Type=notify-reload</varname> services, to inform the service manager that the request to + reload the service has been received and is now being processed.</para></listitem> + </varlistentry> + + <varlistentry> + <term>MONOTONIC_USEC=…</term> + + <listitem><para>A field carrying the monotonic timestamp (as per + <constant>CLOCK_MONOTONIC</constant>) formatted in decimal in µs, when the notification message was + generated by the client. This is typically used in combination with <literal>RELOADING=1</literal>, + to allow the service manager to properly synchronize reload cycles. See + <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry> + for details, specifically <literal>Type=notify-reload</literal>.</para></listitem> </varlistentry> <varlistentry> |