1
1
mirror of https://github.com/systemd/systemd-stable.git synced 2025-01-11 05:17:44 +03:00

man: document protocol error type for service failures (#4724)

This commit is contained in:
Jouke Witteveen 2016-11-23 22:51:33 +01:00 committed by Martin Pitt
parent d6fceaf1f7
commit e0c7d5f7be

View File

@ -1771,14 +1771,15 @@
<listitem><para>Only defined for the service unit type, this environment variable is passed to all
<varname>ExecStop=</varname> and <varname>ExecStopPost=</varname> processes, and encodes the service
"result". Currently, the following values are defined: <literal>timeout</literal> (in case of an operation
timeout), <literal>exit-code</literal> (if a service process exited with a non-zero exit code; see
<varname>$EXIT_CODE</varname> below for the actual exit code returned), <literal>signal</literal> (if a
service process was terminated abnormally by a signal; see <varname>$EXIT_CODE</varname> below for the actual
signal used for the termination), <literal>core-dump</literal> (if a service process terminated abnormally and
dumped core), <literal>watchdog</literal> (if the watchdog keep-alive ping was enabled for the service but it
missed the deadline), or <literal>resources</literal> (a catch-all condition in case a system operation
failed).</para>
"result". Currently, the following values are defined: <literal>protocol</literal> (in case of a protocol
violation; if a service did not take the steps required by its configuration), <literal>timeout</literal> (in
case of an operation timeout), <literal>exit-code</literal> (if a service process exited with a non-zero exit
code; see <varname>$EXIT_CODE</varname> below for the actual exit code returned), <literal>signal</literal>
(if a service process was terminated abnormally by a signal; see <varname>$EXIT_CODE</varname> below for the
actual signal used for the termination), <literal>core-dump</literal> (if a service process terminated
abnormally and dumped core), <literal>watchdog</literal> (if the watchdog keep-alive ping was enabled for the
service but it missed the deadline), or <literal>resources</literal> (a catch-all condition in case a system
operation failed).</para>
<para>This environment variable is useful to monitor failure or successful termination of a service. Even
though this variable is available in both <varname>ExecStop=</varname> and <varname>ExecStopPost=</varname>, it