[systemd-commits] 5 commits - make-directive-index.py Makefile.am man/crypttab.xml man/journalctl.xml man/kernel-command-line.xml man/localectl.xml man/loginctl.xml man/pam_systemd.xml man/runlevel.xml man/sd_listen_fds.xml man/sd_notify.xml man/systemctl.xml man/systemd.automount.xml man/systemd-bootchart.xml man/systemd-coredumpctl.xml man/systemd-cryptsetup-generator.xml man/systemd.exec.xml man/systemd-fsck at .service.xml man/systemd-fstab-generator.xml man/systemd-journald.service.xml man/systemd-journal-gatewayd.service.xml man/systemd.kill.xml man/systemd-modules-load.service.xml man/systemd.mount.xml man/systemd.path.xml man/systemd-quotacheck.service.xml man/systemd.service.xml man/systemd.socket.xml man/systemd.swap.xml man/systemd.timer.xml man/systemd-udevd.service.xml man/systemd.unit.xml man/systemd-vconsole-setup.service.xml man/systemd.xml man/timedatectl.xml man/udev.xml tmpfiles.d/tmp.conf

Zbigniew Jędrzejewski-Szmek zbyszek at kemper.freedesktop.org
Sat Jan 26 08:48:42 PST 2013


 Makefile.am                              |   25 ------
 make-directive-index.py                  |  115 ++++++++++++++++++++++---------
 man/crypttab.xml                         |    2 
 man/journalctl.xml                       |    2 
 man/kernel-command-line.xml              |    2 
 man/localectl.xml                        |    2 
 man/loginctl.xml                         |    2 
 man/pam_systemd.xml                      |    4 -
 man/runlevel.xml                         |    4 -
 man/sd_listen_fds.xml                    |    2 
 man/sd_notify.xml                        |    2 
 man/systemctl.xml                        |    2 
 man/systemd-bootchart.xml                |    2 
 man/systemd-coredumpctl.xml              |    8 +-
 man/systemd-cryptsetup-generator.xml     |    2 
 man/systemd-fsck at .service.xml            |    2 
 man/systemd-fstab-generator.xml          |    2 
 man/systemd-journal-gatewayd.service.xml |   28 +++----
 man/systemd-journald.service.xml         |    2 
 man/systemd-modules-load.service.xml     |    2 
 man/systemd-quotacheck.service.xml       |    2 
 man/systemd-udevd.service.xml            |    6 -
 man/systemd-vconsole-setup.service.xml   |    2 
 man/systemd.automount.xml                |    2 
 man/systemd.exec.xml                     |   12 +--
 man/systemd.kill.xml                     |    2 
 man/systemd.mount.xml                    |    4 -
 man/systemd.path.xml                     |    2 
 man/systemd.service.xml                  |    4 -
 man/systemd.socket.xml                   |    2 
 man/systemd.swap.xml                     |    2 
 man/systemd.timer.xml                    |    2 
 man/systemd.unit.xml                     |    4 -
 man/systemd.xml                          |    4 -
 man/timedatectl.xml                      |    2 
 man/udev.xml                             |   44 +++++------
 tmpfiles.d/tmp.conf                      |    1 
 37 files changed, 172 insertions(+), 137 deletions(-)

New commits:
commit d970bd6d39f808b29a804050747c0883fcc2784b
Author: Zbigniew Jędrzejewski-Szmek <zbyszek at in.waw.pl>
Date:   Sat Jan 26 11:27:35 2013 -0500

    make-directive-index: use original XML as index entries
    
    udev(7) fields are now display in whole, which looks
    much better.

diff --git a/make-directive-index.py b/make-directive-index.py
index 29c594c..ab40997 100755
--- a/make-directive-index.py
+++ b/make-directive-index.py
@@ -158,7 +158,7 @@ This index contains {count} entries in {sections} sections,
 referring to {pages} individual manual pages.
 '''
 
-def _extract_directives(directive_groups, page):
+def _extract_directives(directive_groups, formatting, page):
     t = tree.parse(page)
     section = t.find('./refmeta/manvolnum').text
     pagename = t.find('./refmeta/refentrytitle').text
@@ -173,13 +173,19 @@ def _extract_directives(directive_groups, page):
             for name in variablelist.iterfind(xpath):
                 text = re.sub(r'([= ]).*', r'\1', name.text).rstrip()
                 stor[text].append((pagename, section))
+                if text not in formatting:
+                    # use element as formatted display
+                    name.tail = ''
+                    name.text = text
+                    formatting[text] = name
 
-def _make_section(template, name, directives):
+def _make_section(template, name, directives, formatting):
     varlist = template.find(".//*[@id='{}']".format(name))
     for varname, manpages in sorted(directives.items()):
         entry = tree.SubElement(varlist, 'varlistentry')
-        a = tree.SubElement(tree.SubElement(entry, 'term'), 'varname')
-        a.text = varname
+        term = tree.SubElement(entry, 'term')
+        term.append(formatting[varname])
+
         para = tree.SubElement(tree.SubElement(entry, 'listitem'), 'para')
 
         b = None
@@ -206,7 +212,7 @@ def _make_colophon(template, groups):
                                 sections=len(groups),
                                 pages=len(pages))
 
-def _make_page(template, directive_groups):
+def _make_page(template, directive_groups, formatting):
     """Create an XML tree from directive_groups.
 
     directive_groups = {
@@ -216,7 +222,7 @@ def _make_page(template, directive_groups):
     }
     """
     for name, directives in directive_groups.items():
-            _make_section(template, name, directives)
+            _make_section(template, name, directives, formatting)
 
     _make_colophon(template, directive_groups.values())
 
@@ -228,13 +234,14 @@ def make_page(*xml_files):
     names = [vl.get('id') for vl in template.iterfind('.//variablelist')]
     directive_groups = {name:collections.defaultdict(list)
                         for name in names}
+    formatting = {}
     for page in xml_files:
         try:
-            _extract_directives(directive_groups, page)
+            _extract_directives(directive_groups, formatting, page)
         except Exception:
             raise ValueError("failed to process " + page)
 
-    return _make_page(template, directive_groups)
+    return _make_page(template, directive_groups, formatting)
 
 if __name__ == '__main__':
     tree.dump(make_page(*sys.argv[1:]))

commit ccc9a4f9ffdab069b0b785627c48962fdadf6d46
Author: Zbigniew Jędrzejewski-Szmek <zbyszek at in.waw.pl>
Date:   Sat Jan 26 10:47:16 2013 -0500

    man: extend systemd.directives(7) to all manual pages
    
    New sections are added: PAM options, crypttab options, commandline
    options, miscellaneous. The last category will be used for all
    untagged <varname> elements.
    
    Commandline options sections is meant to be a developer tool: when
    adding an option it is sometimes useful to be able to check if
    similarly named options exist elsewhere.

diff --git a/Makefile.am b/Makefile.am
index f362b53..9c92bff 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -767,31 +767,12 @@ MANPAGES += \
 	man/systemd.index.7 \
 	man/systemd.directives.7
 
-XML_DIRECTIVE_FILES = \
-	man/systemd.xml \
-	man/systemd.unit.xml \
-	man/systemd.service.xml \
-	man/systemd.socket.xml \
-	man/systemd.mount.xml \
-	man/systemd.automount.xml \
-	man/systemd.swap.xml \
-	man/systemd.target.xml \
-	man/systemd.path.xml \
-	man/systemd.timer.xml \
-	man/systemd.snapshot.xml \
-	man/systemd.exec.xml \
-	man/systemd.kill.xml \
-	man/systemd.device.xml \
-	man/systemd.conf.xml \
-	man/systemd.journal-fields.xml \
-	man/systemd.time.xml \
-	man/bootchart.conf.xml
-
-man/systemd.index.xml: make-man-index.py $(filter-out man/systemd.index.xml,$(XML_FILES))
+NON_INDEX_XML_FILES = $(filter-out man/systemd.index.xml,$(XML_FILES))
+man/systemd.index.xml: make-man-index.py $(NON_INDEX_XML_FILES)
 	$(AM_V_at)$(MKDIR_P) $(dir $@)
 	$(AM_V_GEN)$(PYTHON) $^ > $@
 
-man/systemd.directives.xml: make-directive-index.py $(XML_DIRECTIVE_FILES)
+man/systemd.directives.xml: make-directive-index.py $(filter-out man/systemd.directives.xml,$(NON_INDEX_XML_FILES))
 	$(AM_V_at)$(MKDIR_P) $(dir $@)
 	$(AM_V_GEN)$(PYTHON) $^ > $@
 
diff --git a/make-directive-index.py b/make-directive-index.py
index 48d830e..29c594c 100755
--- a/make-directive-index.py
+++ b/make-directive-index.py
@@ -2,7 +2,7 @@
 #
 #  This file is part of systemd.
 #
-#  Copyright 2012 Zbigniew Jędrzejewski-Szmek
+#  Copyright 2012-2013 Zbigniew Jędrzejewski-Szmek
 #
 #  systemd is free software; you can redistribute it and/or modify it
 #  under the terms of the GNU Lesser General Public License as published by
@@ -20,6 +20,7 @@
 import sys
 import collections
 import xml.etree.ElementTree as tree
+import re
 
 TEMPLATE = '''\
 <refentry id="systemd.directives">
@@ -58,27 +59,19 @@ TEMPLATE = '''\
         </refsect1>
 
         <refsect1>
-                <title>System manager directives</title>
-
-                <para>Directives for configuring the behaviour of the
-                systemd process.</para>
-
-                <variablelist id='systemd-directives' />
-        </refsect1>
-
-        <refsect1>
                 <title>Options on the kernel command line</title>
 
                 <para>Kernel boot options for configuring the behaviour of the
                 systemd process.</para>
 
-                <variablelist id='kernel-commandline-directives' />
+                <variablelist id='kernel-commandline-options' />
         </refsect1>
 
         <refsect1>
                 <title>Environment variables</title>
 
-                <para>Environment variables understood by the systemd process.</para>
+                <para>Environment variables understood by the systemd
+                manager and other programs.</para>
 
                 <variablelist id='environment-variables' />
         </refsect1>
@@ -93,15 +86,40 @@ TEMPLATE = '''\
         </refsect1>
 
         <refsect1>
-                <title>Journal directives</title>
+                <title>Journal fields</title>
 
-                <para>Directives for configuring the behaviour of the
-                journald process.</para>
+                <para>Fields in the journal events with a well known meaning.</para>
 
                 <variablelist id='journal-directives' />
         </refsect1>
 
         <refsect1>
+                <title>PAM configuration directives</title>
+
+                <para>Directives for configuring PAM behaviour.</para>
+
+                <variablelist id='pam-directives' />
+        </refsect1>
+
+        <refsect1>
+                <title>crypttab options</title>
+
+                <para>Options which influence mounted filesystems and
+                encrypted volumes.</para>
+
+                <variablelist id='crypttab-options' />
+        </refsect1>
+
+        <refsect1>
+                <title>System manager directives</title>
+
+                <para>Directives for configuring the behaviour of the
+                systemd process.</para>
+
+                <variablelist id='systemd-directives' />
+        </refsect1>
+
+        <refsect1>
                 <title>bootchart.conf directives</title>
 
                 <para>Directives for configuring the behaviour of the
@@ -111,6 +129,24 @@ TEMPLATE = '''\
         </refsect1>
 
         <refsect1>
+                <title>command-line options</title>
+
+                <para>Command-line options accepted by programs in the
+                systemd suite.</para>
+
+                <variablelist id='options' />
+        </refsect1>
+
+        <refsect1>
+                <title>Miscellaneous options and directives</title>
+
+                <para>Other configuration elements which don't fit in
+                any of the above groups.</para>
+
+                <variablelist id='miscellaneous' />
+        </refsect1>
+
+        <refsect1>
                 <title>Colophon</title>
                 <para id='colophon' />
         </refsect1>
@@ -127,11 +163,16 @@ def _extract_directives(directive_groups, page):
     section = t.find('./refmeta/manvolnum').text
     pagename = t.find('./refmeta/refentrytitle').text
     for variablelist in t.iterfind('.//variablelist'):
-        klass = variablelist.attrib.get('class') or 'unit-directives'
-        stor = directive_groups[klass]
-        for varname in variablelist.iterfind('./varlistentry/term/varname'):
-            text = ''.join(varname.text.partition('=')[:2])
-            stor[text].append((pagename, section))
+        klass = variablelist.attrib.get('class')
+        storvar = directive_groups[klass or 'miscellaneous']
+        storopt = directive_groups['options']
+        # <option>s go in OPTIONS, unless class is specified
+        for xpath, stor in (('./varlistentry/term/varname', storvar),
+                            ('./varlistentry/term/option',
+                             storvar if klass else storopt)):
+            for name in variablelist.iterfind(xpath):
+                text = re.sub(r'([= ]).*', r'\1', name.text).rstrip()
+                stor[text].append((pagename, section))
 
 def _make_section(template, name, directives):
     varlist = template.find(".//*[@id='{}']".format(name))
@@ -142,7 +183,7 @@ def _make_section(template, name, directives):
         para = tree.SubElement(tree.SubElement(entry, 'listitem'), 'para')
 
         b = None
-        for manpage, manvolume in sorted(manpages):
+        for manpage, manvolume in sorted(set(manpages)):
                 if b is not None:
                         b.tail = ', '
                 b = tree.SubElement(para, 'citerefentry')
@@ -181,16 +222,19 @@ def _make_page(template, directive_groups):
 
     return template
 
-def make_page(xml_files):
+def make_page(*xml_files):
     "Extract directives from xml_files and return XML index tree."
     template = tree.fromstring(TEMPLATE)
     names = [vl.get('id') for vl in template.iterfind('.//variablelist')]
     directive_groups = {name:collections.defaultdict(list)
                         for name in names}
     for page in xml_files:
-        _extract_directives(directive_groups, page)
+        try:
+            _extract_directives(directive_groups, page)
+        except Exception:
+            raise ValueError("failed to process " + page)
 
     return _make_page(template, directive_groups)
 
 if __name__ == '__main__':
-    tree.dump(make_page(sys.argv[1:]))
+    tree.dump(make_page(*sys.argv[1:]))
diff --git a/man/crypttab.xml b/man/crypttab.xml
index acc7029..2379fc0 100644
--- a/man/crypttab.xml
+++ b/man/crypttab.xml
@@ -103,7 +103,7 @@
                 comma-delimited list of options.  The following
                 options are recognized:</para>
 
-                <variablelist>
+                <variablelist class='crypttab-options'>
                         <varlistentry>
                                 <term><varname>cipher=</varname></term>
 
diff --git a/man/journalctl.xml b/man/journalctl.xml
index 959ae1e..d8f8f68 100644
--- a/man/journalctl.xml
+++ b/man/journalctl.xml
@@ -518,7 +518,7 @@
         <refsect1>
                 <title>Environment</title>
 
-                <variablelist>
+                <variablelist class='environment-variables'>
                         <varlistentry>
                                 <term><varname>$SYSTEMD_PAGER</varname></term>
                                 <listitem><para>Pager to use when
diff --git a/man/kernel-command-line.xml b/man/kernel-command-line.xml
index 154d399..f249798 100644
--- a/man/kernel-command-line.xml
+++ b/man/kernel-command-line.xml
@@ -74,7 +74,7 @@
         <refsect1>
                 <title>Core OS Command Line Arguments</title>
 
-                <variablelist>
+                <variablelist class='kernel-commandline-options'>
                         <varlistentry>
                                 <term><varname>systemd.unit=</varname></term>
                                 <term><varname>rd.systemd.unit=</varname></term>
diff --git a/man/localectl.xml b/man/localectl.xml
index 73bff98..7563eb5 100644
--- a/man/localectl.xml
+++ b/man/localectl.xml
@@ -229,7 +229,7 @@
         <refsect1>
                 <title>Environment</title>
 
-                <variablelist>
+                <variablelist class='environment-variables'>
                         <varlistentry>
                                 <term><varname>$SYSTEMD_PAGER</varname></term>
                                 <listitem><para>Pager to use when
diff --git a/man/loginctl.xml b/man/loginctl.xml
index 9d082cf..90b6f1e 100644
--- a/man/loginctl.xml
+++ b/man/loginctl.xml
@@ -457,7 +457,7 @@
         <refsect1>
                 <title>Environment</title>
 
-                <variablelist>
+                <variablelist class='environment-variables'>
                         <varlistentry>
                                 <term><varname>$SYSTEMD_PAGER</varname></term>
                                 <listitem><para>Pager to use when
diff --git a/man/pam_systemd.xml b/man/pam_systemd.xml
index 600bfd7..0093a8f 100644
--- a/man/pam_systemd.xml
+++ b/man/pam_systemd.xml
@@ -118,7 +118,7 @@
 
                 <para>The following options are understood:</para>
 
-                <variablelist>
+                <variablelist class='pam-directives'>
                         <varlistentry>
                                 <term><option>kill-session-processes=</option></term>
 
@@ -247,7 +247,7 @@
 
                 <para>The following environment variables are set for the processes of the user's session:</para>
 
-                <variablelist>
+                <variablelist class='environment-variables'>
                         <varlistentry>
                                 <term><varname>$XDG_SESSION_ID</varname></term>
 
diff --git a/man/runlevel.xml b/man/runlevel.xml
index 0ad4953..6d9fe85 100644
--- a/man/runlevel.xml
+++ b/man/runlevel.xml
@@ -96,7 +96,7 @@
         <refsect1>
                 <title>Environment</title>
 
-                <variablelist>
+                <variablelist class='environment-variables'>
                         <varlistentry>
                                 <term><varname>$RUNLEVEL</varname></term>
 
diff --git a/man/sd_listen_fds.xml b/man/sd_listen_fds.xml
index b891b6b..9c8fdbc 100644
--- a/man/sd_listen_fds.xml
+++ b/man/sd_listen_fds.xml
@@ -168,7 +168,7 @@
         <refsect1>
                 <title>Environment</title>
 
-                <variablelist>
+                <variablelist class='environment-variables'>
                         <varlistentry>
                                 <term><varname>$LISTEN_PID</varname></term>
                                 <term><varname>$LISTEN_FDS</varname></term>
diff --git a/man/sd_notify.xml b/man/sd_notify.xml
index 75edeea..81f74aa 100644
--- a/man/sd_notify.xml
+++ b/man/sd_notify.xml
@@ -254,7 +254,7 @@
         <refsect1>
                 <title>Environment</title>
 
-                <variablelist>
+                <variablelist class='environment-variables'>
                         <varlistentry>
                                 <term><varname>$NOTIFY_SOCKET</varname></term>
 
diff --git a/man/systemctl.xml b/man/systemctl.xml
index 60a0f40..3842645 100644
--- a/man/systemctl.xml
+++ b/man/systemctl.xml
@@ -1296,7 +1296,7 @@
         <refsect1>
                 <title>Environment</title>
 
-                <variablelist>
+                <variablelist class='environment-variables'>
                         <varlistentry>
                                 <term><varname>$SYSTEMD_PAGER</varname></term>
                                 <listitem><para>Pager to use when
diff --git a/man/systemd-bootchart.xml b/man/systemd-bootchart.xml
index 8c4d7cc..0df7c4b 100644
--- a/man/systemd-bootchart.xml
+++ b/man/systemd-bootchart.xml
@@ -65,7 +65,7 @@
 
                 <para>systemd-bootchart can be invoked in several different ways:</para>
 
-                <variablelist class='bootchart-invocation'>
+                <variablelist>
 
                         <varlistentry>
                                 <title>Kernel invocation</title>
diff --git a/man/systemd-cryptsetup-generator.xml b/man/systemd-cryptsetup-generator.xml
index 49d4d55..c5f8d2a 100644
--- a/man/systemd-cryptsetup-generator.xml
+++ b/man/systemd-cryptsetup-generator.xml
@@ -72,7 +72,7 @@
                 <para><filename>systemd-cryptsetup-generator</filename> understands
                 the following kernel command line parameters:</para>
 
-                <variablelist>
+                <variablelist class='kernel-commandline-options'>
                         <varlistentry>
                                 <term><varname>luks=</varname></term>
                                 <term><varname>rd.luks=</varname></term>
diff --git a/man/systemd-fsck at .service.xml b/man/systemd-fsck at .service.xml
index 62f6311..4d6464c 100644
--- a/man/systemd-fsck at .service.xml
+++ b/man/systemd-fsck at .service.xml
@@ -77,7 +77,7 @@
                 <para><filename>systemd-fsck</filename> understands
                 one kernel command line parameter:</para>
 
-                <variablelist>
+                <variablelist class='kernel-commandline-options'>
                         <varlistentry>
                                 <term><varname>fsck.mode=</varname></term>
 
diff --git a/man/systemd-fstab-generator.xml b/man/systemd-fstab-generator.xml
index b265b6c..4bd25bf 100644
--- a/man/systemd-fstab-generator.xml
+++ b/man/systemd-fstab-generator.xml
@@ -81,7 +81,7 @@
                 <para><filename>systemd-fstab-generator</filename> understands
                 the following kernel command line parameters:</para>
 
-                <variablelist>
+                <variablelist class='kernel-commandline-options'>
 
                         <varlistentry>
                                 <term><varname>fstab=</varname></term>
diff --git a/man/systemd-journald.service.xml b/man/systemd-journald.service.xml
index abc03df..4969ab1 100644
--- a/man/systemd-journald.service.xml
+++ b/man/systemd-journald.service.xml
@@ -137,7 +137,7 @@
                 <filename>journald.conf</filename> may be overridden on
                 the kernel command line:</para>
 
-                <variablelist>
+                <variablelist class='kernel-commandline-options'>
                         <varlistentry>
                                 <term><varname>systemd.journald.forward_to_syslog=</varname></term>
                                 <term><varname>systemd.journald.forward_to_kmsg=</varname></term>
diff --git a/man/systemd-modules-load.service.xml b/man/systemd-modules-load.service.xml
index e5f10a7..ea10be2 100644
--- a/man/systemd-modules-load.service.xml
+++ b/man/systemd-modules-load.service.xml
@@ -71,7 +71,7 @@
                 <para><filename>systemd-modules-load.service</filename> understands
                 the following kernel command line parameters:</para>
 
-                <variablelist>
+                <variablelist class='kernel-commandline-options'>
 
                         <varlistentry>
                                 <term><varname>modules-load=</varname></term>
diff --git a/man/systemd-quotacheck.service.xml b/man/systemd-quotacheck.service.xml
index 4d0218b..2ffee91 100644
--- a/man/systemd-quotacheck.service.xml
+++ b/man/systemd-quotacheck.service.xml
@@ -67,7 +67,7 @@
                 <para><filename>systemd-quotacheck</filename> understands
                 one kernel command line parameter:</para>
 
-                <variablelist>
+                <variablelist class='kernel-commandline-options'>
                         <varlistentry>
                                 <term><varname>quotacheck.mode=</varname></term>
 
diff --git a/man/systemd-udevd.service.xml b/man/systemd-udevd.service.xml
index 9fc59c1..2b9a29a 100644
--- a/man/systemd-udevd.service.xml
+++ b/man/systemd-udevd.service.xml
@@ -116,7 +116,7 @@
   </refsect1>
 
   <refsect1><title>Environment</title>
-    <variablelist>
+    <variablelist class='environment-variables'>
       <varlistentry>
         <term><varname>$UDEV_LOG=</varname></term>
         <listitem>
@@ -127,7 +127,7 @@
  </refsect1>
 
   <refsect1><title>Kernel command line</title>
-    <variablelist>
+    <variablelist class='kernel-commandline-options'>
       <para>Parameters starting with "rd." will be read when
       <command>systemd-udevd</command> is used in an initrd.</para>
       <varlistentry>
diff --git a/man/systemd-vconsole-setup.service.xml b/man/systemd-vconsole-setup.service.xml
index c1ef80d..df1b1a1 100644
--- a/man/systemd-vconsole-setup.service.xml
+++ b/man/systemd-vconsole-setup.service.xml
@@ -76,7 +76,7 @@
                 <filename>vconsole.conf</filename> may be overridden on
                 the kernel command line:</para>
 
-                <variablelist>
+                <variablelist class='kernel-commandline-options'>
                         <varlistentry>
                                 <term><varname>vconsole.keymap=</varname></term>
                                 <term><varname>vconsole.keymap.toggle=</varname></term>
diff --git a/man/systemd.automount.xml b/man/systemd.automount.xml
index 7575835..f428ddf 100644
--- a/man/systemd.automount.xml
+++ b/man/systemd.automount.xml
@@ -123,7 +123,7 @@
                 specific to the [Automount] section of automount units
                 are the following:</para>
 
-                <variablelist>
+                <variablelist class='unit-directives'>
 
                         <varlistentry>
                                 <term><varname>Where=</varname></term>
diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml
index fb74bcc..53094e5 100644
--- a/man/systemd.exec.xml
+++ b/man/systemd.exec.xml
@@ -82,7 +82,7 @@
         <refsect1>
                 <title>Options</title>
 
-                <variablelist>
+                <variablelist class='unit-directives'>
 
                         <varlistentry>
                                 <term><varname>WorkingDirectory=</varname></term>
diff --git a/man/systemd.kill.xml b/man/systemd.kill.xml
index 1bff7b8..5ff8fee 100644
--- a/man/systemd.kill.xml
+++ b/man/systemd.kill.xml
@@ -82,7 +82,7 @@
         <refsect1>
                 <title>Options</title>
 
-                <variablelist>
+                <variablelist class='unit-directives'>
 
                         <varlistentry>
                                 <term><varname>KillMode=</varname></term>
diff --git a/man/systemd.mount.xml b/man/systemd.mount.xml
index f319cf7..022be46 100644
--- a/man/systemd.mount.xml
+++ b/man/systemd.mount.xml
@@ -182,7 +182,7 @@
                 options specific to the [Mount] section of mount
                 units are the following:</para>
 
-                <variablelist>
+                <variablelist class='unit-directives'>
 
                         <varlistentry>
                                 <term><varname>What=</varname></term>
@@ -276,7 +276,7 @@
                 for compatibility reasons and should not be used in
                 newly written mount files.</para>
 
-                <variablelist>
+                <variablelist class='unit-directives'>
                         <varlistentry>
                                 <term><varname>FsckPassNo=</varname></term>
 
diff --git a/man/systemd.path.xml b/man/systemd.path.xml
index a602caa..ccf16df 100644
--- a/man/systemd.path.xml
+++ b/man/systemd.path.xml
@@ -108,7 +108,7 @@
                 monitors. The options specific to the [Path] section
                 of path units are the following:</para>
 
-                <variablelist>
+                <variablelist class='unit-directives'>
                         <varlistentry>
                                 <term><varname>PathExists=</varname></term>
                                 <term><varname>PathExistsGlob=</varname></term>
diff --git a/man/systemd.service.xml b/man/systemd.service.xml
index 891b347..d2feb98 100644
--- a/man/systemd.service.xml
+++ b/man/systemd.service.xml
@@ -121,7 +121,7 @@
                 options specific to the <literal>[Service]</literal>
                 section of service units are the following:</para>
 
-                <variablelist>
+                <variablelist class='unit-directives'>
                         <varlistentry>
                                 <term><varname>Type=</varname></term>
 
@@ -887,7 +887,7 @@
                 for compatibility reasons and should not be used in
                 newly written service files.</para>
 
-                <variablelist>
+                <variablelist class='unit-directives'>
                         <varlistentry>
                                 <term><varname>SysVStartPriority=</varname></term>
                                 <listitem><para>Set the SysV start
diff --git a/man/systemd.socket.xml b/man/systemd.socket.xml
index 7ba8bdc..28730ca 100644
--- a/man/systemd.socket.xml
+++ b/man/systemd.socket.xml
@@ -143,7 +143,7 @@
                 options specific to the [Socket] section of socket
                 units are the following:</para>
 
-                <variablelist>
+                <variablelist class='unit-directives'>
                         <varlistentry>
                                 <term><varname>ListenStream=</varname></term>
                                 <term><varname>ListenDatagram=</varname></term>
diff --git a/man/systemd.swap.xml b/man/systemd.swap.xml
index dae9d59..e547e71 100644
--- a/man/systemd.swap.xml
+++ b/man/systemd.swap.xml
@@ -136,7 +136,7 @@
                 options specific to the [Swap] section of swap units
                 are the following:</para>
 
-                <variablelist>
+                <variablelist class='unit-directives'>
 
                         <varlistentry>
                                 <term><varname>What=</varname></term>
diff --git a/man/systemd.timer.xml b/man/systemd.timer.xml
index 8682643..2c2ba58 100644
--- a/man/systemd.timer.xml
+++ b/man/systemd.timer.xml
@@ -97,7 +97,7 @@
                 defines. The options specific to the [Timer] section
                 of timer units are the following:</para>
 
-                <variablelist>
+                <variablelist class='unit-directives'>
                         <varlistentry>
                                 <term><varname>OnActiveSec=</varname></term>
                                 <term><varname>OnBootSec=</varname></term>
diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml
index 953a289..dcdfc1e 100644
--- a/man/systemd.unit.xml
+++ b/man/systemd.unit.xml
@@ -222,7 +222,7 @@
                 carries generic information about the unit that is not
                 dependent on the type of unit:</para>
 
-                <variablelist>
+                <variablelist class='unit-directives'>
 
                         <varlistentry>
                                 <term><varname>Description=</varname></term>
@@ -944,7 +944,7 @@
                 <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                 tool during installation of a unit:</para>
 
-                <variablelist>
+                <variablelist class='unit-directives'>
                         <varlistentry>
                                 <term><varname>Alias=</varname></term>
 
diff --git a/man/systemd.xml b/man/systemd.xml
index 962ed56..bae90a5 100644
--- a/man/systemd.xml
+++ b/man/systemd.xml
@@ -508,7 +508,7 @@
         <refsect1>
                 <title>Directories</title>
 
-                <variablelist>
+                <variablelist class='unit-directives'>
                         <varlistentry>
                                 <term>System unit directories</term>
 
@@ -987,7 +987,7 @@
                 <filename>/proc/cmdline</filename>
                 instead.</para></footnote>:</para>
 
-                <variablelist class='kernel-commandline-directives'>
+                <variablelist class='kernel-commandline-options'>
                         <varlistentry>
                                 <term><varname>systemd.unit=</varname></term>
                                 <term><varname>rd.systemd.unit=</varname></term>
diff --git a/man/timedatectl.xml b/man/timedatectl.xml
index 01ca0a7..4f34bb7 100644
--- a/man/timedatectl.xml
+++ b/man/timedatectl.xml
@@ -221,7 +221,7 @@
         <refsect1>
                 <title>Environment</title>
 
-                <variablelist>
+                <variablelist class='environment-variables'>
                         <varlistentry>
                                 <term><varname>$SYSTEMD_PAGER</varname></term>
                                 <listitem><para>Pager to use when
diff --git a/man/udev.xml b/man/udev.xml
index 773635e..415cf8e 100644
--- a/man/udev.xml
+++ b/man/udev.xml
@@ -148,7 +148,7 @@
       not only the device that has generated the event. If multiple keys that match
       a parent device are specified in a single rule, all these keys must match at
       one and the same parent device.</para>
-      <variablelist>
+      <variablelist class='udev-directives'>
         <varlistentry>
           <term><option>ACTION</option></term>
           <listitem>
@@ -322,7 +322,7 @@
       </variablelist>
 
       <para>The following keys can get values assigned:</para>
-      <variablelist>
+      <variablelist class='udev-directives'>
         <varlistentry>
           <term><option>NAME</option></term>
           <listitem>
@@ -489,7 +489,7 @@
           <term><option>OPTIONS</option></term>
           <listitem>
             <para>Rule and device options:</para>
-            <variablelist>
+            <variablelist class='udev-directives'>
               <varlistentry>
                 <term><option>link_priority=<replaceable>value</replaceable></option></term>
                 <listitem>
@@ -546,7 +546,7 @@
       is executed, allowing for the use of device properties set by earlier matching
       rules. For all other fields, substitutions are performed while the individual rule is
       being processed. The available substitutions are:</para>
-      <variablelist>
+      <variablelist class='udev-directives'>
         <varlistentry>
           <term><option>$kernel</option>, <option>%k</option></term>
           <listitem>

commit 6b76fa66199967b4ec71854f717d0b8ee94497c4
Author: Zbigniew Jędrzejewski-Szmek <zbyszek at in.waw.pl>
Date:   Sat Jan 26 10:45:37 2013 -0500

    man: docbook consitency fixes
    
    Use proper (or at least more proper) docbook tags for various
    fields. This should help with automatic parsing of the documentation.

diff --git a/man/runlevel.xml b/man/runlevel.xml
index 02d5371..0ad4953 100644
--- a/man/runlevel.xml
+++ b/man/runlevel.xml
@@ -124,7 +124,7 @@
 
                 <variablelist>
                         <varlistentry>
-                                <term><varname>/var/run/utmp</varname></term>
+                                <term><filename>/var/run/utmp</filename></term>
 
                                 <listitem><para>The utmp database
                                 <command>runlevel</command> reads the
diff --git a/man/systemd-coredumpctl.xml b/man/systemd-coredumpctl.xml
index 53b82ed..87ed6fa 100644
--- a/man/systemd-coredumpctl.xml
+++ b/man/systemd-coredumpctl.xml
@@ -162,7 +162,7 @@
 
                 <variablelist>
                         <varlistentry>
-                                <term><option>PID</option></term>
+                                <term><replaceable>PID</replaceable></term>
 
                                 <listitem><para>Process ID of the
                                 process that dumped
@@ -170,7 +170,7 @@
                         </varlistentry>
 
                         <varlistentry>
-                                <term><option>COMM</option></term>
+                                <term><replaceable>COMM</replaceable></term>
 
                                 <listitem><para>Name of the executable
                                 (matches <option>COREDUMP_COMM=</option>).
@@ -179,7 +179,7 @@
                         </varlistentry>
 
                         <varlistentry>
-                                <term><option>EXE</option></term>
+                                <term><replaceable>EXE</replaceable></term>
 
                                 <listitem><para>Path to the executable
                                 (matches <option>COREDUMP_EXE=</option>).
@@ -188,7 +188,7 @@
                         </varlistentry>
 
                         <varlistentry>
-                                <term><option>MATCH</option></term>
+                                <term><replaceable>MATCH</replaceable></term>
 
                                 <listitem><para>General journalctl predicates
                                 (see <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>).
diff --git a/man/systemd-journal-gatewayd.service.xml b/man/systemd-journal-gatewayd.service.xml
index 37b39c2..44cd616 100644
--- a/man/systemd-journal-gatewayd.service.xml
+++ b/man/systemd-journal-gatewayd.service.xml
@@ -124,13 +124,13 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
 
     <variablelist>
       <varlistentry>
-        <term><option>/browse</option></term>
+        <term><uri>/browse</uri></term>
 
         <listitem><para>Interactive browsing.</para></listitem>
       </varlistentry>
 
       <varlistentry>
-        <term><option>/entries[?option1&option2=value...]</option></term>
+        <term><uri>/entries[?option1&option2=value...]</uri></term>
 
         <listitem><para>Retrieval of events in various formats.</para>
 
@@ -149,7 +149,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
       </varlistentry>
 
       <varlistentry>
-        <term><option>/machine</option></term>
+        <term><uri>/machine</uri></term>
 
         <listitem><para>Return a JSON structure describing the machine.</para>
 
@@ -167,7 +167,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
       </varlistentry>
 
       <varlistentry>
-        <term><option>/fields/</option><replaceable>FIELD_NAME</replaceable></term>
+        <term><uri>/fields/<replaceable>FIELD_NAME</replaceable></uri></term>
 
         <listitem><para>Return a list of values of this field present in the logs.</para>
         </listitem>
@@ -179,14 +179,14 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <title>Accept header</title>
 
     <para>
-      <option>Accept: </option><replaceable>format</replaceable>
+      <option>Accept: <replaceable>format</replaceable></option>
     </para>
 
     <para>Recognized formats:</para>
 
     <variablelist>
       <varlistentry>
-        <term><option>text/plain</option></term>
+        <term><constant>text/plain</constant></term>
 
         <listitem><para>The default. Plaintext syslog-like output,
         one line per journal entry
@@ -195,7 +195,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
       </varlistentry>
 
       <varlistentry>
-        <term><option>application/json</option></term>
+        <term><constant>application/json</constant></term>
 
         <listitem><para>Entries are formatted as JSON data structures,
         one per line
@@ -207,7 +207,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
       </varlistentry>
 
       <varlistentry>
-        <term><option>application/event-stream</option></term>
+        <term><constant>application/event-stream</constant></term>
 
         <listitem><para>Entries are formatted as JSON data structures,
         wrapped in a format suitable for <ulink
@@ -219,7 +219,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
       </varlistentry>
 
       <varlistentry>
-        <term><option>application/vnd.fdo.journal</option></term>
+        <term><constant>application/vnd.fdo.journal</constant></term>
 
         <listitem><para>Entries are serialized into a binary (but
         mostly text-based) stream suitable for backups and network
@@ -237,7 +237,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <title>Range header</title>
 
     <para>
-      <option>Range: entries=<cursor>[[:<num_skip>]:<num_entries>]</option>
+      <option>Range: entries=<replaceable>cursor</replaceable>[[:<replaceable>num_skip</replaceable>]:<replaceable>num_entries</replaceable>]</option>
     </para>
 
     <para>where
@@ -256,7 +256,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
 
     <variablelist>
       <varlistentry>
-        <term><option>follow</option></term>
+        <term><uri>follow</uri></term>
 
         <listitem><para>wait for new events
         (like <command>journalctl --follow</command>, except that
@@ -265,7 +265,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
       </varlistentry>
 
       <varlistentry>
-        <term><option>discrete</option></term>
+        <term><uri>discrete</uri></term>
 
         <listitem><para>Test that the specified cursor refers to an
         entry in the journal. Returns just this entry.</para>
@@ -273,14 +273,14 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
       </varlistentry>
 
       <varlistentry>
-        <term><option>boot</option></term>
+        <term><uri>boot</uri></term>
 
         <listitem><para>Limit events to the current boot of the system
         (like <command>journalctl --this--boot</command>).</para></listitem>
       </varlistentry>
 
       <varlistentry>
-        <term><option><KEY>=<match></option></term>
+        <term><uri><replaceable>KEY</replaceable>=<replaceable>match</replaceable></uri></term>
 
         <listitem><para>Match journal fields. See
         <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>
diff --git a/man/systemd-udevd.service.xml b/man/systemd-udevd.service.xml
index 92fb38f..9fc59c1 100644
--- a/man/systemd-udevd.service.xml
+++ b/man/systemd-udevd.service.xml
@@ -118,7 +118,7 @@
   <refsect1><title>Environment</title>
     <variablelist>
       <varlistentry>
-        <term><varname>UDEV_LOG=</varname></term>
+        <term><varname>$UDEV_LOG=</varname></term>
         <listitem>
           <para>Set the logging priority.</para>
         </listitem>
diff --git a/man/udev.xml b/man/udev.xml
index 7ec7a3f..773635e 100644
--- a/man/udev.xml
+++ b/man/udev.xml
@@ -65,7 +65,7 @@
       The following variables can be set:</para>
       <variablelist>
         <varlistentry>
-          <term><option>udev_log</option></term>
+          <term><varname>udev_log</varname></term>
           <listitem>
             <para>The logging priority. Valid values are the numerical syslog priorities
             or their textual representations: <option>err</option>, <option>info</option>
@@ -107,21 +107,21 @@
       operators are:</para>
       <variablelist>
         <varlistentry>
-          <term><option>==</option></term>
+          <term><literal>==</literal></term>
           <listitem>
             <para>Compare for equality.</para>
           </listitem>
         </varlistentry>
 
         <varlistentry>
-          <term><option>!=</option></term>
+          <term><literal>!=</literal></term>
           <listitem>
             <para>Compare for inequality.</para>
           </listitem>
         </varlistentry>
 
         <varlistentry>
-          <term><option>=</option></term>
+          <term><literal>=</literal></term>
           <listitem>
             <para>Assign a value to a key. Keys that represent a list are reset
             and only this single value is assigned.</para>
@@ -129,14 +129,14 @@
         </varlistentry>
 
         <varlistentry>
-          <term><option>+=</option></term>
+          <term><literal>+=</literal></term>
           <listitem>
             <para>Add the value to a key that holds a list of entries.</para>
           </listitem>
         </varlistentry>
 
         <varlistentry>
-          <term><option>:=</option></term>
+          <term><literal>:=</literal></term>
           <listitem>
             <para>Assign  a  value  to  a key finally; disallow any later changes.</para>
           </listitem>
@@ -297,19 +297,19 @@
       pattern characters are supported:</para>
       <variablelist>
         <varlistentry>
-          <term><option>*</option></term>
+          <term><literal>*</literal></term>
           <listitem>
             <para>Matches zero or more characters.</para>
           </listitem>
         </varlistentry>
         <varlistentry>
-          <term><option>?</option></term>
+          <term><literal>?</literal></term>
           <listitem>
             <para>Matches any single character.</para>
           </listitem>
         </varlistentry>
         <varlistentry>
-          <term><option>[]</option></term>
+          <term><literal>[]</literal></term>
           <listitem>
             <para>Matches any single character specified within the brackets. For
             example, the pattern string 'tty[SR]' would match either 'ttyS' or 'ttyR'.
@@ -354,7 +354,7 @@
         </varlistentry>
 
         <varlistentry>
-          <term><option>OWNER, GROUP, MODE</option></term>
+          <term><option>OWNER</option>, <option>GROUP</option>, <option>MODE</option></term>
           <listitem>
             <para>The permissions for the device node. Every specified value overrides
             the compiled-in default value.</para>
@@ -427,10 +427,10 @@
           <term><option>IMPORT{<replaceable>type</replaceable>}</option></term>
           <listitem>
             <para>Import a set of variables as device properties,
-            depending on <replaceable>type</replaceable>:</para>
+            depending on <literal>type</literal>:</para>
             <variablelist>
               <varlistentry>
-                <term><option>program</option></term>
+                <term><literal>program</literal></term>
                 <listitem>
                   <para>Execute an external program specified as the assigned value and
                   import its output, which must be in environment key
@@ -439,14 +439,14 @@
                 </listitem>
               </varlistentry>
               <varlistentry>
-                <term><option>file</option></term>
+                <term><literal>file</literal></term>
                 <listitem>
                   <para>Import a text file specified as the assigned value, the content
                   of which must be in environment key format.</para>
                 </listitem>
               </varlistentry>
               <varlistentry>
-                <term><option>db</option></term>
+                <term><literal>db</literal></term>
                 <listitem>
                   <para>Import a single property specified as the assigned value from the
                   current device database. This works only if the database is already populated
@@ -454,14 +454,14 @@
                 </listitem>
               </varlistentry>
               <varlistentry>
-                <term><option>cmdline</option></term>
+                <term><literal>cmdline</literal></term>
                 <listitem>
                   <para>Import a single property from the kernel command line. For simple flags
                   the value of the property is set to '1'.</para>
                 </listitem>
               </varlistentry>
               <varlistentry>
-                <term><option>parent</option></term>
+                <term><literal>parent</literal></term>
                 <listitem>
                   <para>Import the stored keys from the parent device by reading
                   the database entry of the parent device. The value assigned to
@@ -677,14 +677,14 @@
         </varlistentry>
 
         <varlistentry>
-          <term><option>%%</option></term>
+          <term><literal>%%</literal></term>
           <listitem>
           <para>The '%' character itself.</para>
           </listitem>
         </varlistentry>
 
         <varlistentry>
-          <term><option>$$</option></term>
+          <term><literal>$$</literal></term>
           <listitem>
           <para>The '$' character itself.</para>
           </listitem>

commit 652d0dd7097984801fca0378b762bf96e8fda029
Author: Zbigniew Jędrzejewski-Szmek <zbyszek at in.waw.pl>
Date:   Fri Jan 25 14:25:43 2013 -0500

    man: mention that PrivateTmp means /var/tmp too

diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml
index a0fca59..fb74bcc 100644
--- a/man/systemd.exec.xml
+++ b/man/systemd.exec.xml
@@ -1096,15 +1096,17 @@
                                 <listitem><para>Takes a boolean
                                 argument. If true sets up a new file
                                 system namespace for the executed
-                                processes and mounts a private
-                                <filename>/tmp</filename> directory
-                                inside it, that is not shared by
+                                processes and mounts private
+                                <filename>/tmp</filename> and
+                                <filename>/var/tmp</filename> directories
+                                inside it, that are not shared by
                                 processes outside of the
                                 namespace. This is useful to secure
                                 access to temporary files of the
                                 process, but makes sharing between
                                 processes via
-                                <filename>/tmp</filename>
+                                <filename>/tmp</filename> or
+                                <filename>/var/tmp</filename>
                                 impossible. Defaults to
                                 false.</para></listitem>
                         </varlistentry>

commit b08131ec17e9263c3beabfbe1c41562cf1ac40af
Author: Zbigniew Jędrzejewski-Szmek <zbyszek at in.waw.pl>
Date:   Fri Jan 25 14:25:20 2013 -0500

    tmpfiles: exclude /var/tmp/systemd-private-* too

diff --git a/tmpfiles.d/tmp.conf b/tmpfiles.d/tmp.conf
index 031770c..ef5a9f0 100644
--- a/tmpfiles.d/tmp.conf
+++ b/tmpfiles.d/tmp.conf
@@ -13,3 +13,4 @@ d /var/tmp 1777 root root 30d
 
 # Exclude namespace mountpoints created with PrivateTmp=yes
 X /tmp/systemd-private-*
+X /var/tmp/systemd-private-*



More information about the systemd-commits mailing list