From d4de2b2afff6bc1f2d9ca960197bb0388c154221 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= <zbyszek@in.waw.pl>
Date: Tue, 3 Mar 2020 19:08:26 +0100
Subject: [PATCH] man: document that .link/.network/.netdev files have the
 usual ini syntax

Fixes #1266.
---
 man/systemd.link.xml    | 7 +++++--
 man/systemd.netdev.xml  | 5 +++--
 man/systemd.network.xml | 6 ++++--
 man/systemd.syntax.xml  | 9 +++++++++
 4 files changed, 21 insertions(+), 6 deletions(-)

diff --git a/man/systemd.link.xml b/man/systemd.link.xml
index 130cc78693..1dca495a03 100644
--- a/man/systemd.link.xml
+++ b/man/systemd.link.xml
@@ -26,8 +26,11 @@
   <refsect1>
     <title>Description</title>
 
-    <para>Network link configuration is performed by the
-    <command>net_setup_link</command> udev builtin.</para>
+    <para>A plain ini-style text file that encodes configuration for matching network devices, used by
+    <citerefentry><refentrytitle>systemd-udev</refentrytitle><manvolnum>8</manvolnum></citerefentry> and in
+    particular its <command>net_setup_link</command> builtin. See
+    <citerefentry><refentrytitle>systemd.syntax</refentrytitle><manvolnum>5</manvolnum></citerefentry> for a
+    general description of the syntax.</para>
 
     <para>The link files are read from the files located in the system
     network directory <filename>/usr/lib/systemd/network</filename>,
diff --git a/man/systemd.netdev.xml b/man/systemd.netdev.xml
index 6e215a38bb..6ad1dc9e73 100644
--- a/man/systemd.netdev.xml
+++ b/man/systemd.netdev.xml
@@ -27,9 +27,10 @@
   <refsect1>
     <title>Description</title>
 
-    <para>Network setup is performed by
+    <para>A plain ini-style text file that encodes configuration about a virtual network device, used by
     <citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
-    </para>
+    See <citerefentry><refentrytitle>systemd.syntax</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+    for a general description of the syntax.</para>
 
     <para>The main Virtual Network Device file must have the extension <filename>.netdev</filename>;
     other extensions are ignored. Virtual network devices are created as soon as networkd is
diff --git a/man/systemd.network.xml b/man/systemd.network.xml
index 9da078cb7d..bd19b766c3 100644
--- a/man/systemd.network.xml
+++ b/man/systemd.network.xml
@@ -28,9 +28,11 @@
   <refsect1>
     <title>Description</title>
 
-    <para>Network setup is performed by
+    <para>A plain ini-style text file that encodes network configuration for matching network interfaces,
+    used by
     <citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
-    </para>
+    See <citerefentry><refentrytitle>systemd.syntax</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+    for a general description of the syntax.</para>
 
     <para>The main network file must have the extension <filename>.network</filename>; other
     extensions are ignored. Networks are applied to links whenever the links appear.</para>
diff --git a/man/systemd.syntax.xml b/man/systemd.syntax.xml
index 05786cc534..04b1564b17 100644
--- a/man/systemd.syntax.xml
+++ b/man/systemd.syntax.xml
@@ -46,6 +46,15 @@
       <citerefentry><refentrytitle>systemd.nspawn</refentrytitle><manvolnum>5</manvolnum></citerefentry>
       </para></listitem>
 
+      <listitem><para>link files, see
+      <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+      </para></listitem>
+
+      <listitem><para>netdev and network files, see
+      <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+      </para></listitem>
+
       <listitem><para>daemon config files, see
       <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>systemd-user.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,