summaryrefslogtreecommitdiffstats
path: root/man/sd_notify.xml
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2024-03-13 10:04:42 +0100
committerLennart Poettering <lennart@poettering.net>2024-03-14 17:24:24 +0100
commit1e785c50c9257ee13c9dbf57d8045febc195c8bc (patch)
tree39da6d16be17bbf690917e6d322ff5bfcb4ad657 /man/sd_notify.xml
parentnspawn: add some debug logging for sd_notify() messages received by the conta... (diff)
downloadsystemd-1e785c50c9257ee13c9dbf57d8045febc195c8bc.tar.xz
systemd-1e785c50c9257ee13c9dbf57d8045febc195c8bc.zip
docs: document new sd_notify() extensions
Diffstat (limited to 'man/sd_notify.xml')
-rw-r--r--man/sd_notify.xml11
1 files changed, 8 insertions, 3 deletions
diff --git a/man/sd_notify.xml b/man/sd_notify.xml
index a56d039468..d8fe6468a2 100644
--- a/man/sd_notify.xml
+++ b/man/sd_notify.xml
@@ -446,9 +446,14 @@
</variablelist>
<para>The notification messages sent by services are interpreted by the service manager. Unknown
- assignments may be logged, but are otherwise ignored. Thus, it is not useful to send assignments which
- are not in this list. The service manager also sends some messages to <emphasis>its</emphasis>
- notification socket, which are then consumed by the machine or container manager.</para>
+ assignments are ignored. Thus, it is is safe (but often without effect) to send assignments which are not
+ in this list. The protocol is extensible, but care should be taken to ensure private extensions are
+ recognizable as such. Specifically, it is recommend to prefix them with <literal>X_</literal> followed by
+ some namespace identifier. The service manager also sends some messages to <emphasis>its</emphasis>
+ notification socket, which may then consumed by a supervising machine or container manager further up the
+ stack. The service manager sends a number of extension fields, for example
+ <varname>X_SYSTEMD_UNIT_ACTIVE=</varname>, for details see
+ <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
</refsect1>
<refsect1>