richardphibel / rpms / systemd

Forked from rpms/systemd 2 years ago
Clone
b8c242
From 12ce6830c63b4a27bb6d5b7729d70a86079b108f Mon Sep 17 00:00:00 2001
b8c242
From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= <zbyszek@in.waw.pl>
b8c242
Date: Tue, 16 Oct 2018 15:56:35 +0200
b8c242
Subject: [PATCH] man: move description of *Action= modes to
b8c242
 FailureAction=/SuccessAction=
b8c242
b8c242
FailureAction=/SuccessAction= were added later then StartLimitAction=, so it
b8c242
was easiest to refer to the existing description. But those two settings are
b8c242
somewhat simpler (they just execute the action unconditionally) while
b8c242
StartLimitAction= has additional timing and burst parameters, and they are
b8c242
about to take on a more prominent role, so let's move the description of
b8c242
allowed values.
b8c242
b8c242
(cherry picked from commit 454dd6ce7adb744584ecae9aa0bd1acf3a00e9ed)
b8c242
b8c242
Related: #1860899
b8c242
---
b8c242
 man/systemd.unit.xml | 44 +++++++++++++++++++++++---------------------
b8c242
 1 file changed, 23 insertions(+), 21 deletions(-)
b8c242
b8c242
diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml
b8c242
index 7605c43375..802db453a4 100644
b8c242
--- a/man/systemd.unit.xml
b8c242
+++ b/man/systemd.unit.xml
b8c242
@@ -873,6 +873,24 @@
b8c242
         </listitem>
b8c242
       </varlistentry>
b8c242
 
b8c242
+      <varlistentry>
b8c242
+        <term><varname>FailureAction=</varname></term>
b8c242
+        <term><varname>SuccessAction=</varname></term>
b8c242
+
b8c242
+        <listitem><para>Configure the action to take when the unit stops and enters a failed state or inactive
b8c242
+        state. Takes one of <option>none</option>, <option>reboot</option>, <option>reboot-force</option>,
b8c242
+        <option>reboot-immediate</option>, <option>poweroff</option>, <option>poweroff-force</option> or
b8c242
+        <option>poweroff-immediate</option>. If <option>none</option> is set, no action will be triggered.
b8c242
+        <option>reboot</option> causes a reboot following the normal shutdown procedure (i.e. equivalent to
b8c242
+        <command>systemctl reboot</command>). <option>reboot-force</option> causes a forced reboot which will
b8c242
+        terminate all processes forcibly but should cause no dirty file systems on reboot (i.e. equivalent to
b8c242
+        <command>systemctl reboot -f</command>) and <option>reboot-immediate</option> causes immediate execution of the
b8c242
+        <citerefentry><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry> system call, which
b8c242
+        might result in data loss. Similarly, <option>poweroff</option>, <option>poweroff-force</option>,
b8c242
+        <option>poweroff-immediate</option> have the effect of powering down the system with similar semantics. Both
b8c242
+        options default to <option>none</option>.</para></listitem>
b8c242
+      </varlistentry>
b8c242
+
b8c242
       <varlistentry>
b8c242
         <term><varname>JobTimeoutSec=</varname></term>
b8c242
         <term><varname>JobRunningTimeoutSec=</varname></term>
b8c242
@@ -929,29 +947,13 @@
b8c242
       <varlistentry>
b8c242
         <term><varname>StartLimitAction=</varname></term>
b8c242
 
b8c242
-        <listitem><para>Configure the action to take if the rate limit configured with
b8c242
-        <varname>StartLimitIntervalSec=</varname> and <varname>StartLimitBurst=</varname> is hit. Takes one of
b8c242
-        <option>none</option>, <option>reboot</option>, <option>reboot-force</option>,
b8c242
-        <option>reboot-immediate</option>, <option>poweroff</option>, <option>poweroff-force</option> or
b8c242
-        <option>poweroff-immediate</option>. If <option>none</option> is set, hitting the rate limit will trigger no
b8c242
-        action besides that the start will not be permitted. <option>reboot</option> causes a reboot following the
b8c242
-        normal shutdown procedure (i.e. equivalent to <command>systemctl reboot</command>).
b8c242
-        <option>reboot-force</option> causes a forced reboot which will terminate all processes forcibly but should
b8c242
-        cause no dirty file systems on reboot (i.e. equivalent to <command>systemctl reboot -f</command>) and
b8c242
-        <option>reboot-immediate</option> causes immediate execution of the
b8c242
-        <citerefentry><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry> system call, which
b8c242
-        might result in data loss. Similarly, <option>poweroff</option>, <option>poweroff-force</option>,
b8c242
-        <option>poweroff-immediate</option> have the effect of powering down the system with similar
b8c242
-        semantics. Defaults to <option>none</option>.</para></listitem>
b8c242
+        <listitem><para>Configure an additional action to take if the rate limit configured with
b8c242
+        <varname>StartLimitIntervalSec=</varname> and <varname>StartLimitBurst=</varname> is hit.  Takes the same
b8c242
+        values as the setting <varname>FailureAction=</varname>/<varname>SuccessAction=</varname> settings and executes
b8c242
+        the same actions. If <option>none</option> is set, hitting the rate limit will trigger no action besides that
b8c242
+        the start will not be permitted. Defaults to <option>none</option>.</para></listitem>
b8c242
       </varlistentry>
b8c242
 
b8c242
-      <varlistentry>
b8c242
-        <term><varname>FailureAction=</varname></term>
b8c242
-        <term><varname>SuccessAction=</varname></term>
b8c242
-        <listitem><para>Configure the action to take when the unit stops and enters a failed state or inactive
b8c242
-        state. Takes the same values as the setting <varname>StartLimitAction=</varname> setting and executes the same
b8c242
-        actions. Both options default to <option>none</option>.</para></listitem>
b8c242
-      </varlistentry>
b8c242
 
b8c242
       <varlistentry>
b8c242
         <term><varname>RebootArgument=</varname></term>