man: recommend that .network or friends should have a numeric prefix

Closes #23105.
This commit is contained in:
Yu Watanabe 2022-04-18 03:08:55 +09:00
parent bf93f24ad8
commit cc9b6bdc96
3 changed files with 49 additions and 31 deletions

View file

@ -32,15 +32,19 @@
<citerefentry><refentrytitle>systemd.syntax</refentrytitle><manvolnum>7</manvolnum></citerefentry> for a <citerefentry><refentrytitle>systemd.syntax</refentrytitle><manvolnum>7</manvolnum></citerefentry> for a
general description of the syntax.</para> general description of the syntax.</para>
<para>The link files are read from the files located in the system network directory <para>The <filename>.link</filename> files are read from the files located in the system network
<filename>/usr/lib/systemd/network</filename>, the volatile runtime network directory directory <filename>/usr/lib/systemd/network</filename> and
<filename>/usr/local/lib/systemd/network</filename>, the volatile runtime network directory
<filename>/run/systemd/network</filename>, and the local administration network directory <filename>/run/systemd/network</filename>, and the local administration network directory
<filename>/etc/systemd/network</filename>. Link files must have the extension <filename>/etc/systemd/network</filename>. All configuration files are collectively sorted and
<filename>.link</filename>; other extensions are ignored. All link files are collectively sorted processed in alphanumeric order, regardless of the directories in which they live. However, files
and processed in lexical order, regardless of the directories in which they live. However, files with identical filenames replace each other. It is recommended that each filename is prefixed with
with identical filenames replace each other. Files in <filename>/etc/</filename> have the highest a number (e.g. <filename>10-eth0.link</filename>). Otherwise, the default
priority, files in <filename>/run/</filename> take precedence over files with the same name in <filename>.link</filename> files or those generated by
<filename>/usr/lib/</filename>. This can be used to override a system-supplied link file with a <citerefentry><refentrytitle>systemd-network-generator.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
may take precedence over user configured files. Files in <filename>/etc/</filename> have the
highest priority, files in <filename>/run/</filename> take precedence over files with the same name
in <filename>/usr/lib/</filename>. This can be used to override a system-supplied link file with a
local file if needed. As a special case, an empty file (file size 0) or symlink with the same name local file if needed. As a special case, an empty file (file size 0) or symlink with the same name
pointing to <filename>/dev/null</filename> disables the configuration file entirely (it is pointing to <filename>/dev/null</filename> disables the configuration file entirely (it is
"masked").</para> "masked").</para>
@ -71,13 +75,13 @@
<refsect1> <refsect1>
<title>[Match] Section Options</title> <title>[Match] Section Options</title>
<para>A link file is said to match a device if all matches specified by the <para>A link file is said to match an interface if all matches specified by the [Match] section are
[Match] section are satisfied. When a link file does not contain valid settings satisfied. When a link file does not contain valid settings in [Match] section, then the file will
in [Match] section, then the file will match all devices and match all interfaces and <command>systemd-udevd</command> warns about that. Hint: to avoid the
<command>systemd-udevd</command> warns about that. Hint: to avoid the warning and to make it clear warning and to make it clear that all interfaces shall be matched, add the following:
that all interfaces shall be matched, add the following:
<programlisting>OriginalName=*</programlisting> <programlisting>OriginalName=*</programlisting>
The following keys are accepted:</para> The first (in alphanumeric order) of the link files that matches a given interface is applied, all
later files are ignored, even if they match as well. The following keys are accepted:</para>
<variablelist class='network-directives'> <variablelist class='network-directives'>
<!-- This list is reused in systemd.network(3), hence maintain a specific order: <!-- This list is reused in systemd.network(3), hence maintain a specific order:
@ -1211,6 +1215,9 @@ MACAddress=cb:a9:87:65:43:21</programlisting>
</citerefentry>, </citerefentry>,
<citerefentry> <citerefentry>
<refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum> <refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>systemd-network-generator.service</refentrytitle><manvolnum>8</manvolnum>
</citerefentry> </citerefentry>
</para> </para>
</refsect1> </refsect1>

View file

@ -39,17 +39,22 @@
than create its own. Note that the settings of the pre-existing netdev will not be changed by than create its own. Note that the settings of the pre-existing netdev will not be changed by
networkd.</para> networkd.</para>
<para>The <filename>.netdev</filename> files are read from the files located in the system <para>The <filename>.netdev</filename> files are read from the files located in the system network
network directory <filename>/usr/lib/systemd/network</filename>, the volatile runtime network directory <filename>/usr/lib/systemd/network</filename> and
directory <filename>/run/systemd/network</filename> and the local administration network <filename>/usr/local/lib/systemd/network</filename>, the volatile runtime network directory
directory <filename>/etc/systemd/network</filename>. All configuration files are collectively <filename>/run/systemd/network</filename> and the local administration network directory
sorted and processed in lexical order, regardless of the directories in which they live. <filename>/etc/systemd/network</filename>. All configuration files are collectively sorted and
However, files with identical filenames replace each other. Files in <filename>/etc/</filename> processed in alphanumeric order, regardless of the directories in which they live. However, files
have the highest priority, files in <filename>/run/</filename> take precedence over files with with identical filenames replace each other. It is recommended that each filename is prefixed with
the same name in <filename>/usr/lib/</filename>. This can be used to override a system-supplied a number (e.g. <filename>10-vlan.netdev</filename>). Otherwise, <filename>.netdev</filename> files
configuration file with a local file if needed. As a special case, an empty file (file size 0) generated by
or symlink with the same name pointing to <filename>/dev/null</filename> disables the <citerefentry><refentrytitle>systemd-network-generator.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
configuration file entirely (it is "masked").</para> may take precedence over user configured files. Files in <filename>/etc/</filename> have the
highest priority, files in <filename>/run/</filename> take precedence over files with the same name
in <filename>/usr/lib/</filename>. This can be used to override a system-supplied configuration
file with a local file if needed. As a special case, an empty file (file size 0) or symlink with
the same name pointing to <filename>/dev/null</filename> disables the configuration file entirely
(it is "masked").</para>
<para>Along with the netdev file <filename>foo.netdev</filename>, a "drop-in" directory <para>Along with the netdev file <filename>foo.netdev</filename>, a "drop-in" directory
<filename>foo.netdev.d/</filename> may exist. All files with the suffix <literal>.conf</literal> <filename>foo.netdev.d/</filename> may exist. All files with the suffix <literal>.conf</literal>
@ -2433,7 +2438,8 @@ Independent=yes</programlisting>
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry> <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd-network-generator.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
</para> </para>
</refsect1> </refsect1>

View file

@ -42,8 +42,12 @@
<filename>/usr/local/lib/systemd/network</filename>, the volatile runtime network directory <filename>/usr/local/lib/systemd/network</filename>, the volatile runtime network directory
<filename>/run/systemd/network</filename> and the local administration network directory <filename>/run/systemd/network</filename> and the local administration network directory
<filename>/etc/systemd/network</filename>. All configuration files are collectively sorted and <filename>/etc/systemd/network</filename>. All configuration files are collectively sorted and
processed in lexical order, regardless of the directories in which they live. However, files with processed in alphanumeric order, regardless of the directories in which they live. However, files
identical filenames replace each other. Files in <filename>/etc/</filename> have the highest with identical filenames replace each other. It is recommended that each filename is prefixed with
a number (e.g. <filename>10-eth0.network</filename>). Otherwise, the default
<filename>.network</filename> files or those generated by
<citerefentry><refentrytitle>systemd-network-generator.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
may take precedence over user configured files. Files in <filename>/etc/</filename> have the highest
priority, files in <filename>/run/</filename> take precedence over files with the same name under priority, files in <filename>/run/</filename> take precedence over files with the same name under
<filename>/usr/</filename>. This can be used to override a system-supplied configuration file with <filename>/usr/</filename>. This can be used to override a system-supplied configuration file with
a local file if needed. As a special case, an empty file (file size 0) or symlink with the same a local file if needed. As a special case, an empty file (file size 0) or symlink with the same
@ -69,9 +73,9 @@
<title>[Match] Section Options</title> <title>[Match] Section Options</title>
<para>The network file contains a [Match] section, which determines if a given network file may <para>The network file contains a [Match] section, which determines if a given network file may
be applied to a given device; and a [Network] section specifying how the device should be be applied to a given interface; and a [Network] section specifying how the interface should be
configured. The first (in lexical order) of the network files that matches a given device is configured. The first (in alphanumeric order) of the network files that matches a given interface
applied, all later files are ignored, even if they match as well.</para> is applied, all later files are ignored, even if they match as well.</para>
<para>A network file is said to match a network interface if all matches specified by the [Match] <para>A network file is said to match a network interface if all matches specified by the [Match]
section are satisfied. When a network file does not contain valid settings in [Match] section, then section are satisfied. When a network file does not contain valid settings in [Match] section, then
@ -4774,6 +4778,7 @@ Xfrm=xfrm0</programlisting>
<citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd-network-generator.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
</para> </para>
</refsect1> </refsect1>