36d2f4
From 8ad89170001c9aba8849630ddb5da81d9e24a1bc Mon Sep 17 00:00:00 2001
36d2f4
From: Lennart Poettering <lennart@poettering.net>
36d2f4
Date: Mon, 25 Jun 2018 17:21:34 +0200
36d2f4
Subject: [PATCH] man: document new "boot-complete.target" unit
36d2f4
36d2f4
(cherry picked from commit 82ea38258c0f4964c2f3ad3691c6e4554c4f0bb0)
36d2f4
36d2f4
Related: #1872243
36d2f4
---
36d2f4
 man/systemd.special.xml | 23 +++++++++++++++++++++++
36d2f4
 1 file changed, 23 insertions(+)
36d2f4
36d2f4
diff --git a/man/systemd.special.xml b/man/systemd.special.xml
36d2f4
index fb12805fff..c9d4345016 100644
36d2f4
--- a/man/systemd.special.xml
36d2f4
+++ b/man/systemd.special.xml
36d2f4
@@ -29,6 +29,7 @@
36d2f4
     <filename>cryptsetup-pre.target</filename>,
36d2f4
     <filename>cryptsetup.target</filename>,
36d2f4
     <filename>ctrl-alt-del.target</filename>,
36d2f4
+    <filename>boot-complete.target</filename>,
36d2f4
     <filename>default.target</filename>,
36d2f4
     <filename>emergency.target</filename>,
36d2f4
     <filename>exit.target</filename>,
36d2f4
@@ -646,6 +647,28 @@
36d2f4
           </para>
36d2f4
         </listitem>
36d2f4
       </varlistentry>
36d2f4
+        <varlistentry>
36d2f4
+          <term><filename>boot-complete.target</filename></term>
36d2f4
+          <listitem>
36d2f4
+            <para>This target is intended as generic synchronization point for services that shall determine or act on
36d2f4
+            whether the boot process completed successfully. Order units that are required to succeed for a boot process
36d2f4
+            to be considered successful before this unit, and add a <varname>Requires=</varname> dependency from the
36d2f4
+            target unit to them. Order units that shall only run when the boot process is considered successful after the
36d2f4
+            target unit and pull in the target from it, also with <varname>Requires=</varname>. Note that by default this
36d2f4
+            target unit is not part of the initial boot transaction, but is supposed to be pulled in only if required by
36d2f4
+            units that want to run only on successful boots.</para>
36d2f4
+
36d2f4
+            <para>See
36d2f4
+            <citerefentry><refentrytitle>systemd-boot-check-no-failures.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
36d2f4
+            for a service that implements a generic system health check and orders itself before
36d2f4
+            <filename>boot-complete.target</filename>.</para>
36d2f4
+
36d2f4
+            <para>See
36d2f4
+            <citerefentry><refentrytitle>systemd-bless-boot.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
36d2f4
+            for a service that propagates boot success information to the boot loader, and orders itself after
36d2f4
+            <filename>boot-complete.target</filename>.</para>
36d2f4
+          </listitem>
36d2f4
+        </varlistentry>
36d2f4
       <varlistentry>
36d2f4
         <term><filename>syslog.socket</filename></term>
36d2f4
         <listitem>