build-sys: update intructions for Makefile-man.am regeneration

diff --git a/Makefile-man.am b/Makefile-man.am
index c232f486dedf98457366ce77d8628dba4969d76c..73afdd8c9bb61e1decbcfa29ee7af2cc53758213 100644 (file)
--- a/Makefile-man.am
+++ b/Makefile-man.am
@@ -1,6 +1,12 @@
 # Do not edit. Generated by make-man-rules.py.
 # Do not edit. Generated by make-man-rules.py.

-# Regenerate with 'make all update-man-list'.
-
+# To regenerate:
+#   1. Create, update, or remove source .xml files in man/
+#   2. Run 'make update-man-list'
+#   3. Run 'make man' to generate manpages
+#
+# To make a man page conditional on a configure switch add
+# attribute conditional="ENABLE_WHAT" or conditional="WITH_WHAT"
+# to <refentry> element.

 MANPAGES += \
        man/bootup.7 \
        man/busctl.1 \
 MANPAGES += \
        man/bootup.7 \
        man/busctl.1 \


@@ -85,6 +91,7 @@ MANPAGES += \
        man/systemd.exec.5 \
        man/systemd.journal-fields.7 \
        man/systemd.kill.5 \
        man/systemd.exec.5 \
        man/systemd.journal-fields.7 \
        man/systemd.kill.5 \

+       man/systemd.link.5 \

        man/systemd.mount.5 \
        man/systemd.path.5 \
        man/systemd.preset.5 \
        man/systemd.mount.5 \
        man/systemd.path.5 \
        man/systemd.preset.5 \


@@ -100,9 +107,6 @@ MANPAGES += \
        man/systemd.time.7 \
        man/systemd.timer.5 \
        man/systemd.unit.5 \
        man/systemd.time.7 \
        man/systemd.timer.5 \
        man/systemd.unit.5 \

-       man/systemd.link.5 \
-       man/systemd.netdev.5 \
-       man/systemd.network.5 \

        man/telinit.8 \
        man/tmpfiles.d.5 \
        man/udev.7 \
        man/telinit.8 \
        man/tmpfiles.d.5 \
        man/udev.7 \


@@ -1007,7 +1011,9 @@ endif
 
 if ENABLE_NETWORKD
 MANPAGES += \
 
 if ENABLE_NETWORKD
 MANPAGES += \

-       man/systemd-networkd.service.8
+       man/systemd-networkd.service.8 \
+       man/systemd.netdev.5 \
+       man/systemd.network.5

 MANPAGES_ALIAS += \
        man/systemd-networkd.8
 man/systemd-networkd.8: man/systemd-networkd.service.8
 MANPAGES_ALIAS += \
        man/systemd-networkd.8
 man/systemd-networkd.8: man/systemd-networkd.service.8


@@ -1345,6 +1351,8 @@ MANPAGES_ALIAS += \
 
 endif
 
 
 endif
 

+# Really, do not edit this file.
+

 EXTRA_DIST += \
        man/binfmt.d.xml \
        man/bootchart.conf.xml \
 EXTRA_DIST += \
        man/binfmt.d.xml \
        man/bootchart.conf.xml \


@@ -1490,7 +1498,10 @@ EXTRA_DIST += \
        man/systemd.index.xml \
        man/systemd.journal-fields.xml \
        man/systemd.kill.xml \
        man/systemd.index.xml \
        man/systemd.journal-fields.xml \
        man/systemd.kill.xml \

+       man/systemd.link.xml \

        man/systemd.mount.xml \
        man/systemd.mount.xml \

+       man/systemd.netdev.xml \
+       man/systemd.network.xml \

        man/systemd.path.xml \
        man/systemd.preset.xml \
        man/systemd.resource-control.xml \
        man/systemd.path.xml \
        man/systemd.preset.xml \
        man/systemd.resource-control.xml \


@@ -1505,9 +1516,6 @@ EXTRA_DIST += \
        man/systemd.time.xml \
        man/systemd.timer.xml \
        man/systemd.unit.xml \
        man/systemd.time.xml \
        man/systemd.timer.xml \
        man/systemd.unit.xml \

-       man/systemd.link.xml \
-       man/systemd.netdev.xml \
-       man/systemd.network.xml \

        man/systemd.xml \
        man/telinit.xml \
        man/timedatectl.xml \
        man/systemd.xml \
        man/telinit.xml \
        man/timedatectl.xml \

diff --git a/man/systemd.link.xml b/man/systemd.link.xml
index debe65ee5663bfce352874df5681d2572fe6220b..718eb8efdb5bceb35f3537c41f45a29a52978c6a 100644 (file)
--- a/man/systemd.link.xml
+++ b/man/systemd.link.xml
@@ -53,12 +53,12 @@
         <refsect1>
                 <title>Description</title>
 
         <refsect1>
                 <title>Description</title>
 

-                <para>Network link configuration is performed by the <literal>net_setup_link</literal>
+                <para>Network link configuration is performed by the <command>net_setup_link</command>

                 udev builtin.</para>
 
                 <para>The link files are read from the files located in the
                 system network directory <filename>/usr/lib/systemd/network</filename>,
                 udev builtin.</para>
 
                 <para>The link files are read from the files located in the
                 system network directory <filename>/usr/lib/systemd/network</filename>,

-                the volatile runtime network directory <filename>/run/systemd/network</filename>
+                the volatile runtime 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>.link</filename>; other extensions are ignored.
                 All link files are collectively sorted and processed in lexical order,
                 and the local administration network directory <filename>/etc/systemd/network</filename>.
                 Link files must have the extension <filename>.link</filename>; other extensions are ignored.
                 All link files are collectively sorted and processed in lexical order,

diff --git a/tools/make-man-rules.py b/tools/make-man-rules.py
index 6224de3cc01d15a7bce1e2a9fb2b29bf4124355d..9f46f7b889c694c0937fb789c21d055f4ca82dc1 100644 (file)
--- a/tools/make-man-rules.py
+++ b/tools/make-man-rules.py
@@ -42,8 +42,14 @@ endif
 
 HEADER = '''\
 # Do not edit. Generated by make-man-rules.py.
 
 HEADER = '''\
 # Do not edit. Generated by make-man-rules.py.

-# Regenerate with 'make all update-man-list'.
-
+# To regenerate:
+#   1. Create, update, or remove source .xml files in man/
+#   2. Run 'make update-man-list'
+#   3. Run 'make man' to generate manpages
+#
+# To make a man page conditional on a configure switch add
+# attribute conditional="ENABLE_WHAT" or conditional="WITH_WHAT"
+# to <refentry> element.

 '''
 
 HTML_ALIAS_RULE = '''\
 '''
 
 HTML_ALIAS_RULE = '''\


@@ -53,6 +59,8 @@ HTML_ALIAS_RULE = '''\
 
 FOOTER = '''\
 
 
 FOOTER = '''\
 

+# Really, do not edit this file.
+

 EXTRA_DIST += \\
        {files}
 '''
 EXTRA_DIST += \\
        {files}
 '''