man: change noindex="true" to index="false"

[thirdparty/systemd.git] / man / systemd.offline-updates.xml

diff --git a/man/systemd.offline-updates.xml b/man/systemd.offline-updates.xml
index 258d4467845a937c75191b529923472d0e8e737c..89c12b598bdacc2b6e2565c72f9c2bc5070706a0 100644 (file)
--- a/man/systemd.offline-updates.xml
+++ b/man/systemd.offline-updates.xml
@@ -1,10 +1,7 @@
 <?xml version='1.0'?> <!--*-nxml-*-->
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
-
-<!--
-  SPDX-License-Identifier: LGPL-2.1+
--->
+<!-- SPDX-License-Identifier: LGPL-2.1+ -->
 
 <refentry id="systemd.offline-updates">
   <refentryinfo>
@@ -38,13 +35,13 @@
       <listitem>
         <para>The package manager prepares system updates by downloading all (RPM or DEB or
         whatever) packages to update off-line in a special directory
-        <filename noindex="true">/var/lib/system-update</filename> (or
+        <filename index="false">/var/lib/system-update</filename> (or
         another directory of the package/upgrade manager's choice).</para>
       </listitem>
 
       <listitem>
         <para>When the user OK'ed the update, the symlink <filename>/system-update</filename> is
-        created that points to <filename noindex="true">/var/lib/system-update</filename> (or
+        created that points to <filename index="false">/var/lib/system-update</filename> (or
         wherever the directory with the upgrade files is located) and the system is rebooted. This
         symlink is in the root directory, since we need to check for it very early at boot, at a
         time where <filename>/var</filename> is not available yet.</para>
@@ -109,12 +106,12 @@
     <orderedlist>
       <listitem>
         <para>To make things a bit more robust we recommend hooking the update script into
-        <filename>system-update.target</filename> via a <filename noindex='true'>.wants/</filename>
+        <filename>system-update.target</filename> via a <filename index="false">.wants/</filename>
         symlink in the distribution package, rather than depending on <command>systemctl
         enable</command> in the postinst scriptlets of your package. More specifically, for your
         update script create a .service file, without [Install] section, and then add a symlink like
-        <filename noindex='true'>/usr/lib/systemd/system-update.target.wants/foobar.service</filename>
-        → <filename noindex='true'>../foobar.service</filename> to your package.</para>
+        <filename index="false">/usr/lib/systemd/system-update.target.wants/foobar.service</filename>
+        → <filename index="false">../foobar.service</filename> to your package.</para>
       </listitem>
 
       <listitem>
@@ -134,10 +131,22 @@
       </listitem>
 
       <listitem>
-        <para>The update service should declare <varname>DefaultDependencies=false</varname>,
+        <para>The update service should declare <varname>DefaultDependencies=no</varname>,
         <varname>Requires=sysinit.target</varname>, <varname>After=sysinit.target</varname>,
+        <varname>After=system-update-pre.target</varname>, <varname>Before=system-update.target</varname>
         and explicitly pull in any other services it requires.</para>
       </listitem>
+
+      <listitem>
+        <para>It may be desirable to always run an auxiliary unit when booting
+        into offline-updates mode, which itself does not install updates. To
+        do this create a .service file with
+        <varname>Wants=system-update-pre.target</varname> and
+        <varname>Before=system-update-pre.target</varname> and add a symlink
+        to that file under
+        <filename index="false">/usr/lib/systemd/system-update.target.wants</filename>
+        .</para>
+      </listitem>
     </orderedlist>
   </refsect1>