system/systemd
system/systemd
1
0
Fork 0
mirror of https://github.com/systemd/systemd synced 2024-07-21 10:17:21 +00:00
Code Issues Actions 7 Packages Projects Releases Wiki Activity

man/systemd.service: document that Restart=always/on-success are refused

Browse source 
by oneshot services
This commit is contained in:
Mike Yuan 2024-02-01 03:37:52 +08:00
parent d67c51e386
commit a5d9df35ac
No known key found for this signature in database
GPG key ID: 417471C0A40F58B3
1 changed files with 28 additions and 49 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

77
man/systemd.service.xml
View file

@ -790,62 +790,41 @@
<varlistentry>
<term><varname>Restart=</varname></term>
<listitem><para>Configures whether the service shall be
restarted when the service process exits, is killed, or a
timeout is reached. The service process may be the main
service process, but it may also be one of the processes
specified with <varname>ExecStartPre=</varname>,
<varname>ExecStartPost=</varname>,
<varname>ExecStop=</varname>,
<varname>ExecStopPost=</varname>, or
<varname>ExecReload=</varname>. When the death of the process
is a result of systemd operation (e.g. service stop or
restart), the service will not be restarted. Timeouts include
missing the watchdog "keep-alive ping" deadline and a service
start, reload, and stop operation timeouts.</para>
<listitem><para>Configures whether the service shall be restarted when the service process exits,
is killed, or a timeout is reached. The service process may be the main service process, but it may
also be one of the processes specified with <varname>ExecStartPre=</varname>,
<varname>ExecStartPost=</varname>, <varname>ExecStop=</varname>, <varname>ExecStopPost=</varname>,
or <varname>ExecReload=</varname>. When the death of the process is a result of systemd operation
(e.g. service stop or restart), the service will not be restarted. Timeouts include missing the watchdog
"keep-alive ping" deadline and a service start, reload, and stop operation timeouts.</para>
<para>Takes one of
<option>no</option>,
<option>on-success</option>,
<option>on-failure</option>,
<option>on-abnormal</option>,
<option>on-watchdog</option>,
<option>on-abort</option>, or
<option>always</option>.
If set to <option>no</option> (the default), the service will
not be restarted. If set to <option>on-success</option>, it
will be restarted only when the service process exits cleanly.
<para>Takes one of <option>no</option>, <option>on-success</option>, <option>on-failure</option>,
<option>on-abnormal</option>, <option>on-watchdog</option>, <option>on-abort</option>, or
<option>always</option>. If set to <option>no</option> (the default), the service will not be restarted.
If set to <option>on-success</option>, it will be restarted only when the service process exits cleanly.
In this context, a clean exit means any of the following:
<itemizedlist>
<listitem><simpara>exit code of 0;</simpara></listitem>
<listitem><simpara>for types other than
<varname>Type=oneshot</varname>, one of the signals
<constant>SIGHUP</constant>,
<constant>SIGINT</constant>,
<constant>SIGTERM</constant>, or
<constant>SIGPIPE</constant>;</simpara></listitem>
<listitem><simpara>for types other than <varname>Type=oneshot</varname>, one of the signals
<constant>SIGHUP</constant>, <constant>SIGINT</constant>,
<constant>SIGTERM</constant>, or <constant>SIGPIPE</constant>;
</simpara></listitem>
<listitem><simpara>exit statuses and signals specified in
<varname>SuccessExitStatus=</varname>.</simpara></listitem>
</itemizedlist>
If set to
<option>on-failure</option>, the service will be restarted
when the process exits with a non-zero exit code, is
terminated by a signal (including on core dump, but excluding
the aforementioned four signals), when an operation (such as
service reload) times out, and when the configured watchdog
timeout is triggered. If set to <option>on-abnormal</option>,
the service will be restarted when the process is terminated
by a signal (including on core dump, excluding the
aforementioned four signals), when an operation times out, or
when the watchdog timeout is triggered. If set to
<option>on-abort</option>, the service will be restarted only
if the service process exits due to an uncaught signal not
specified as a clean exit status. If set to
<option>on-watchdog</option>, the service will be restarted
only if the watchdog timeout for the service expires. If set
to <option>always</option>, the service will be restarted
regardless of whether it exited cleanly or not, got terminated
abnormally by a signal, or hit a timeout.</para>
If set to <option>on-failure</option>, the service will be restarted when the process exits with
a non-zero exit code, is terminated by a signal (including on core dump, but excluding the aforementioned
four signals), when an operation (such as service reload) times out, and when the configured watchdog
timeout is triggered. If set to <option>on-abnormal</option>, the service will be restarted when
the process is terminated by a signal (including on core dump, excluding the aforementioned four signals),
when an operation times out, or when the watchdog timeout is triggered. If set to <option>on-abort</option>,
the service will be restarted only if the service process exits due to an uncaught signal not specified
as a clean exit status. If set to <option>on-watchdog</option>, the service will be restarted
only if the watchdog timeout for the service expires. If set to <option>always</option>, the service
will be restarted regardless of whether it exited cleanly or not, got terminated abnormally by
a signal, or hit a timeout. Note that <varname>Type=oneshot</varname> services will never be restarted
on a clean exit status, i.e. <option>always</option> and <option>on-success</option> are rejected
for them.</para>
<table>
<title>Exit causes and the effect of the <varname>Restart=</varname> settings</title>