From: Alvin Šipraga <alsi@bang-olufsen.dk>
Date: Fri, 16 Apr 2021 13:04:24 +0000 (+0200)
Subject: man: clarify RequiredFamilyForOnline= behaviour for online state
X-Git-Tag: v249-rc1~204^2~3
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=553022c4af6d50cc9439867b3dae3b2f751b004a;p=thirdparty%2Fsystemd.git

man: clarify RequiredFamilyForOnline= behaviour for online state

With new "online state" semantics in networkd, make the description of
RequiredFamilyForOnline= a little more broad. Some rewording has been
done to make the passage easier to understand.
---

diff --git a/man/systemd.network.xml b/man/systemd.network.xml
index d1c823789ff..64bd036e0c8 100644
--- a/man/systemd.network.xml
+++ b/man/systemd.network.xml
@@ -232,13 +232,13 @@
       <varlistentry>
         <term><varname>RequiredFamilyForOnline=</varname></term>
         <listitem>
-          <para>Specifies an address family. When specified,
-          <command>systemd-networkd-wait-online</command> waits for at least one routable or link-local
-          IP address in the family should be configured on the link. Takes one of
-          <literal>ipv4</literal>, <literal>ipv6</literal>, <literal>both</literal>, or
-          <literal>any</literal>. Defaults to <literal>any</literal>. Note that this will be used only
-          when <varname>RequiredForOnline=</varname> is true, or its minimum operational state is
-          <literal>degraded</literal> or above. Otherwise, it will be ignored.</para>
+          <para>Takes an address family. When specified, an IP address in the given family is deemed required
+          when determining whether the link is online (including when running
+          <command>systemd-networkd-wait-online</command>). Takes one of <literal>ipv4</literal>,
+          <literal>ipv6</literal>, <literal>both</literal>, or <literal>any</literal>. Defaults to
+          <literal>any</literal>. Note that this option has no effect if
+          <literal>RequiredForOnline=no</literal>, or if <literal>RequiredForOnline=</literal> specifies a
+          minimum operational state below <literal>degraded</literal>.</para>
         </listitem>
       </varlistentry>
       <varlistentry>