]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
network: doc and code typo fixes (#36422)
authorSteve Ramage <github@sjrx.net>
Tue, 18 Feb 2025 17:08:16 +0000 (09:08 -0800)
committerGitHub <noreply@github.com>
Tue, 18 Feb 2025 17:08:16 +0000 (02:08 +0900)
This fixes some typos in the documentation, both grammar as well as
incorrect field names.
It also changes the casing of CheckSum to Checksum in L2TP to match
other casings.

NEWS
man/systemd.netdev.xml
man/systemd.network.xml
src/network/netdev/netdev-gperf.gperf
test/test-network/conf/25-l2tp-udp.netdev

diff --git a/NEWS b/NEWS
index 5ed27af30ca7610b22fa275b439194a64315a43c..3eae7078e3ecf56612966c2d084773cff9d42ed0 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -5613,7 +5613,7 @@ CHANGES WITH 250:
           IP addresses outside of the configured IP pool range for the server.
 
         * CAN support in systemd-networkd gained four new settings Loopback=,
-          OneShot=, PresumeAck=, ClassicDataLengthCode= for tweaking CAN
+          OneShot=, PresumeACK=, ClassicDataLengthCode= for tweaking CAN
           control modes. It gained a number of further settings for tweaking
           CAN timing quanta.
 
index b809bd220e0ac10863266b57d14aa1d2d92d4af0..b88c51b90e70b5f2dbc35008cabc3ee9c21aaec0 100644 (file)
       <varlistentry>
         <term><varname>TunnelId=</varname></term>
         <listitem>
-          <para>Specifies the tunnel identifier. Takes an number in the range 1…4294967295. The value used
+          <para>Specifies the tunnel identifier. Takes a number in the range 1…4294967295. The value used
           must match the <literal>PeerTunnelId=</literal> value being used at the peer. This setting is
           compulsory.</para>
 
         </listitem>
       </varlistentry>
       <varlistentry>
-        <term><varname>UDP6ZeroChecksumTx=</varname></term>
+        <term><varname>UDP6ChecksumTx=</varname></term>
         <listitem>
           <para>Takes a boolean. When true, skip UDP checksum calculation for transmitted packets over IPv6.</para>
 
         </listitem>
       </varlistentry>
       <varlistentry>
-        <term><varname>UDP6ZeroChecksumRx=</varname></term>
+        <term><varname>UDP6ChecksumRx=</varname></term>
         <listitem>
           <para>Takes a boolean. When true, allows incoming UDP packets over IPv6 with zero checksum field.</para>
 
       <varlistentry>
         <term><varname>SessionId=</varname></term>
         <listitem>
-          <para>Specifies the session identifier. Takes an number in the range 1…4294967295. The value used
+          <para>Specifies the session identifier. Takes a number in the range 1…4294967295. The value used
           must match the <literal>SessionId=</literal> value being used at the peer. This setting is
           compulsory.</para>
 
       <varlistentry>
         <term><varname>PeerSessionId=</varname></term>
         <listitem>
-          <para>Specifies the peer session identifier. Takes an number in the range 1…4294967295.
+          <para>Specifies the peer session identifier. Takes a number in the range 1…4294967295.
           The value used must match the <literal>PeerSessionId=</literal> value being used at the peer.
           This setting is compulsory.</para>
 
       <varlistentry>
         <term><varname>ERSPANHardwareId=</varname></term>
         <listitem>
-          <para>Specifies an unique identifier of the ERSPAN v2 engine. Takes an integer in the range 0…63.
+          <para>Specifies a unique identifier of the ERSPAN v2 engine. Takes an integer in the range 0…63.
           Only used when <varname>ERSPANVersion=2</varname>. Defaults to 0.</para>
 
           <xi:include href="version-info.xml" xpointer="v252"/>
           <para>Takes a boolean. Specifies that duplicate frames (received on inactive ports)
           should be dropped when false, or delivered when true. Normally, bonding will drop
           duplicate frames (received on inactive ports), which is desirable for
-          most users. But there are some times it is nice to allow duplicate
+          most users. But there are some cases where it is nice to allow duplicate
           frames to be delivered. The default value is false (drop duplicate frames
           received on inactive ports).
           </para>
       </varlistentry>
 
       <varlistentry id='ipoib_umcast'>
-        <term><varname>IgnoreUserspaceMulticastGroup=</varname></term>
+        <term><varname>IgnoreUserspaceMulticastGroups=</varname></term>
         <listitem>
-          <para>Takes an boolean value. When true, the kernel ignores multicast groups handled by
+          <para>Takes a boolean value. When true, the kernel ignores multicast groups handled by
           userspace. Defaults to unset, and the kernel's default is used.</para>
 
           <xi:include href="version-info.xml" xpointer="v250"/>
index a10a4616d04367695e3a1aae86a0192d1e986029..c1618c0f94c27a3daa571ab4810384e1f164aa76 100644 (file)
@@ -884,7 +884,7 @@ DuplicateAddressDetection=none</programlisting></para>
         <term><varname>IPMasquerade=</varname></term>
         <listitem>
           <para>Configures IP masquerading for the network interface. If enabled, packets forwarded
-          from the network interface will be appear as coming from the local host. Typically, this should be
+          from the network interface will appear as coming from the local host. Typically, this should be
           enabled on the downstream interface of routers. Takes one of <literal>ipv4</literal>,
           <literal>ipv6</literal>, <literal>both</literal>, or <literal>no</literal>. Defaults to
           <literal>no</literal>. Note that any positive boolean values such as <literal>yes</literal> or
@@ -1359,7 +1359,7 @@ DuplicateAddressDetection=none</programlisting></para>
           <citerefentry project='man-pages'><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
           If set to true, then the IPv4 broadcast address will be derived from the
           <varname>Address=</varname> setting. If set to false, then the broadcast address will not be
-          set. Defaults to true, except for wireguard interfaces, where it default to false.</para>
+          set. Defaults to true, except for wireguard interfaces, where it defaults to false.</para>
 
           <xi:include href="version-info.xml" xpointer="v211"/>
         </listitem>
@@ -4932,7 +4932,7 @@ ServerAddress=192.168.0.1/24</programlisting>
         </listitem>
       </varlistentry>
       <varlistentry>
-        <term><varname>PresumeAck=</varname></term>
+        <term><varname>PresumeACK=</varname></term>
         <listitem>
           <para>Takes a boolean. When <literal>yes</literal>, the interface will ignore missing CAN
           ACKs. When unset, the kernel's default will be used.</para>
index dcd786d87f1f25a2112fa5ca9691dae57c8abbd9..612f463e337329f101b49a386c101e12464eaabb 100644 (file)
@@ -113,9 +113,12 @@ L2TP.UDPDestinationPort,                  config_parse_ip_port,
 L2TP.Local,                               config_parse_l2tp_tunnel_local_address,    0,                             0
 L2TP.Remote,                              config_parse_l2tp_tunnel_remote_address,   0,                             0
 L2TP.EncapsulationType,                   config_parse_l2tp_encap_type,              0,                             offsetof(L2tpTunnel, l2tp_encap_type)
-L2TP.UDPCheckSum,                         config_parse_bool,                         0,                             offsetof(L2tpTunnel, udp_csum)
-L2TP.UDP6CheckSumRx,                      config_parse_bool,                         0,                             offsetof(L2tpTunnel, udp6_csum_rx)
-L2TP.UDP6CheckSumTx,                      config_parse_bool,                         0,                             offsetof(L2tpTunnel, udp6_csum_tx)
+L2TP.UDPChecksum,                         config_parse_bool,                         0,                             offsetof(L2tpTunnel, udp_csum)
+L2TP.UDPCheckSum,                         config_parse_bool,                         0,                             offsetof(L2tpTunnel, udp_csum) /* deprecated */
+L2TP.UDP6ChecksumRx,                      config_parse_bool,                         0,                             offsetof(L2tpTunnel, udp6_csum_rx)
+L2TP.UDP6CheckSumRx,                      config_parse_bool,                         0,                             offsetof(L2tpTunnel, udp6_csum_rx) /* deprecated */
+L2TP.UDP6ChecksumTx,                      config_parse_bool,                         0,                             offsetof(L2tpTunnel, udp6_csum_tx)
+L2TP.UDP6CheckSumTx,                      config_parse_bool,                         0,                             offsetof(L2tpTunnel, udp6_csum_tx) /* deprecated */
 L2TPSession.SessionId,                    config_parse_l2tp_session_id,              0,                             0
 L2TPSession.PeerSessionId,                config_parse_l2tp_session_id,              0,                             0
 L2TPSession.Layer2SpecificHeader,         config_parse_l2tp_session_l2spec,          0,                             0
index 79824df5d47c81623c3eb6daeabf039e3872222e..4adbf6ab59501f9acbcb3703ccccaf8b3446bbac 100644 (file)
@@ -12,8 +12,8 @@ Local=static@test1
 Remote=192.168.30.101
 EncapsulationType=udp
 UDPCheckSum=true
-UDP6CheckSumRx=true
-UDP6CheckSumTx=true
+UDP6ChecksumRx=true
+UDP6ChecksumTx=true
 
 [L2TPSession]
 SessionId=15