From 38f901791f3c4b1cbd04b71323bbef2fdab65f83 Mon Sep 17 00:00:00 2001
From: Mike Yuan <me@yhndnzj.com>
Date: Sun, 14 May 2023 17:48:25 +0800
Subject: unit-file: support UpheldBy= in [Install] settings (adding Upholds=
 deps from .upholds/)

Closes #26896
---
 man/systemctl.xml    |  9 ++++-----
 man/systemd.unit.xml | 39 ++++++++++++++++++++++-----------------
 2 files changed, 26 insertions(+), 22 deletions(-)

(limited to 'man')

diff --git a/man/systemctl.xml b/man/systemctl.xml
index 009aabacb9..0e786fd966 100644
--- a/man/systemctl.xml
+++ b/man/systemctl.xml
@@ -367,10 +367,9 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
           <listitem>
             <para>Shows units required and wanted by the specified
             units. This recursively lists units following the
-            <varname>Requires=</varname>,
-            <varname>Requisite=</varname>,
-            <varname>ConsistsOf=</varname>,
-            <varname>Wants=</varname>, <varname>BindsTo=</varname>
+            <varname>Requires=</varname>, <varname>Requisite=</varname>,
+            <varname>Wants=</varname>, <varname>ConsistsOf=</varname>,
+            <varname>BindsTo=</varname>, and <varname>Upholds=</varname>
             dependencies. If no units are specified,
             <filename>default.target</filename> is implied.</para>
 
@@ -1791,7 +1790,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err
           <para>Show reverse dependencies between units with
           <command>list-dependencies</command>, i.e. follow
           dependencies of type <varname>WantedBy=</varname>,
-          <varname>RequiredBy=</varname>,
+          <varname>RequiredBy=</varname>, <varname>UpheldBy=</varname>,
           <varname>PartOf=</varname>, <varname>BoundBy=</varname>,
           instead of <varname>Wants=</varname> and similar.
           </para>
diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml
index c618e403f7..e28bfe845e 100644
--- a/man/systemd.unit.xml
+++ b/man/systemd.unit.xml
@@ -749,8 +749,7 @@
 
         <para>When <varname>Upholds=b.service</varname> is used on <filename>a.service</filename>, this
         dependency will show as <varname>UpheldBy=a.service</varname> in the property listing of
-        <filename>b.service</filename>. The <varname>UpheldBy=</varname> dependency cannot be specified
-        directly.</para>
+        <filename>b.service</filename>.</para>
         </listitem>
       </varlistentry>
 
@@ -1848,6 +1847,12 @@
             <entry>[Unit] section</entry>
             <entry>[Install] section</entry>
           </row>
+          <row>
+            <entry><varname>Upholds=</varname></entry>
+            <entry><varname>UpheldBy=</varname></entry>
+            <entry>[Unit] section</entry>
+            <entry>[Install] section</entry>
+          </row>
           <row>
             <entry><varname>PartOf=</varname></entry>
             <entry><varname>ConsistsOf=</varname></entry>
@@ -1895,10 +1900,10 @@
       </tgroup>
     </table>
 
-    <para>Note: <varname>WantedBy=</varname> and <varname>RequiredBy=</varname> are
-    used in the [Install] section to create symlinks in <filename>.wants/</filename>
-    and <filename>.requires/</filename> directories. They cannot be used directly as a
-    unit configuration setting.</para>
+    <para>Note: <varname>WantedBy=</varname>, <varname>RequiredBy=</varname>, and <varname>UpheldBy=</varname>
+    are used in the [Install] section to create symlinks in <filename>.wants/</filename>,
+    <filename>.requires/</filename>, and <filename>.upholds/</filename> directories. They cannot be used
+    directly as a unit configuration setting.</para>
 
     <para>Note: <varname>ConsistsOf=</varname>, <varname>BoundBy=</varname>,
     <varname>RequisiteOf=</varname>, <varname>ConflictedBy=</varname> are created
@@ -1947,23 +1952,23 @@
       <varlistentry>
         <term><varname>WantedBy=</varname></term>
         <term><varname>RequiredBy=</varname></term>
+        <term><varname>UpheldBy=</varname></term>
 
         <listitem><para>This option may be used more than once, or a space-separated list of unit names may
-        be given. A symbolic link is created in the <filename>.wants/</filename> or
-        <filename>.requires/</filename> directory of each of the listed units when this unit is installed by
-        <command>systemctl enable</command>. This has the effect of a dependency of type
-        <varname>Wants=</varname> or <varname>Requires=</varname> being added from the listed unit to the
-        current unit. The primary result is that the current unit will be started when the listed unit is
-        started, see the description of <varname>Wants=</varname> and <varname>Requires=</varname> in the
-        [Unit] section for details.</para>
+        be given. A symbolic link is created in the <filename>.wants/</filename>, <filename>.requires/</filename>,
+        or <filename>.upholds/</filename> directory of each of the listed units when this unit is installed
+        by <command>systemctl enable</command>. This has the effect of a dependency of type
+        <varname>Wants=</varname>, <varname>Requires=</varname>, or <varname>Upholds=</varname> being added
+        from the listed unit to the current unit. See the description of the mentioned dependency types
+        in the [Unit] section for details.</para>
 
         <para>In case of template units listing non template units, the listing unit must have
         <varname>DefaultInstance=</varname> set, or <command>systemctl enable</command> must be called with
         an instance name. The instance (default or specified) will be added to the
-        <filename>.wants/</filename> or <filename>.requires/</filename> list of the listed unit. For example,
-        <command>WantedBy=getty.target</command> in a service <filename>getty@.service</filename> will result
-        in <command>systemctl enable getty@tty2.service</command> creating a
-        <filename>getty.target.wants/getty@tty2.service</filename> link to
+        <filename>.wants/</filename>, <filename>.requires/</filename>, or <filename>.upholds/</filename>
+        list of the listed unit. For example, <command>WantedBy=getty.target</command> in a service
+        <filename>getty@.service</filename> will result in <command>systemctl enable getty@tty2.service</command>
+        creating a <filename>getty.target.wants/getty@tty2.service</filename> link to
         <filename>getty@.service</filename>. This also applies to listing specific instances of templated
         units: this specific instance will gain the dependency. A template unit may also list a template
         unit, in which case a generic dependency will be added where each instance of the listing unit will
-- 
cgit v1.2.1