chiark / gitweb /
units: introduce new Documentation= field and make use of it everywhere
authorLennart Poettering <lennart@poettering.net>
Mon, 21 May 2012 13:12:18 +0000 (15:12 +0200)
committerLennart Poettering <lennart@poettering.net>
Mon, 21 May 2012 13:14:51 +0000 (15:14 +0200)
This should help making the boot process a bit easier to explore and
understand for the administrator. The simple idea is that "systemctl
status" now shows a link to documentation alongside the other status and
decriptionary information of a service.

This patch adds the necessary fields to all our shipped units if we have
proper documentation for them.

91 files changed:
man/systemd.special.xml
man/systemd.unit.xml
src/core/dbus-unit.c
src/core/dbus-unit.h
src/core/load-fragment-gperf.gperf.m4
src/core/load-fragment.c
src/core/load-fragment.h
src/core/unit.c
src/core/unit.h
src/shared/util.c
src/shared/util.h
src/systemctl/systemctl.c
units/basic.target
units/bluetooth.target
units/cryptsetup.target
units/dev-hugepages.mount
units/dev-mqueue.mount
units/emergency.service.in
units/emergency.target
units/final.target
units/getty.target
units/getty@.service.m4
units/graphical.target
units/halt.target
units/hibernate.target
units/http-daemon.target
units/kexec.target
units/local-fs-pre.target
units/local-fs.target
units/mail-transfer-agent.target
units/multi-user.target
units/network.target
units/nss-lookup.target
units/nss-user-lookup.target
units/poweroff.target
units/printer.target
units/proc-sys-fs-binfmt_misc.mount
units/reboot.target
units/remote-fs-pre.target
units/remote-fs.target
units/rescue.service.m4.in
units/rescue.target
units/rpcbind.target
units/serial-getty@.service.m4
units/shutdown.target
units/sigpwr.target
units/sleep.target
units/smartcard.target
units/sockets.target
units/sound.target
units/suspend.target
units/swap.target
units/sysinit.target
units/syslog.socket
units/syslog.target
units/systemd-ask-password-console.path
units/systemd-ask-password-console.service.in
units/systemd-ask-password-plymouth.path
units/systemd-ask-password-plymouth.service.in
units/systemd-ask-password-wall.path
units/systemd-ask-password-wall.service.in
units/systemd-binfmt.service.in
units/systemd-hostnamed.service.in
units/systemd-initctl.service.in
units/systemd-initctl.socket
units/systemd-journald.service.in
units/systemd-journald.socket
units/systemd-localed.service.in
units/systemd-logind.service.in
units/systemd-modules-load.service.in
units/systemd-shutdownd.service.in
units/systemd-shutdownd.socket
units/systemd-sysctl.service.in
units/systemd-timedated-ntp.target
units/systemd-timedated.service.in
units/systemd-tmpfiles-clean.service.in
units/systemd-tmpfiles-clean.timer
units/systemd-tmpfiles-setup.service.in
units/systemd-udev-control.socket
units/systemd-udev-kernel.socket
units/systemd-udev-settle.service.in
units/systemd-udev-trigger.service.in
units/systemd-udev.service.in
units/systemd-update-utmp-runlevel.service.in
units/systemd-update-utmp-shutdown.service.in
units/systemd-vconsole-setup.service.in
units/time-sync.target
units/umount.target
units/user/default.target
units/user/exit.service.in
units/user/exit.target

index 984e998..96befd5 100644 (file)
@@ -49,7 +49,9 @@
 
         <refsynopsisdiv>
                 <para><filename>basic.target</filename>,
+                <filename>bluetooth.target</filename>,
                 <filename>ctrl-alt-del.target</filename>,
+                <filename>cryptsetup.target</filename>,
                 <filename>dbus.service</filename>,
                 <filename>dbus.socket</filename>,
                 <filename>default.target</filename>,
@@ -57,6 +59,7 @@
                 <filename>emergency.target</filename>,
                 <filename>exit.service</filename>,
                 <filename>final.service</filename>,
+                <filename>getty.target</filename>,
                 <filename>graphical.target</filename>,
                 <filename>hibernate.target</filename>,
                 <filename>http-daemon.target</filename>,
@@ -69,7 +72,9 @@
                 <filename>multi-user.target</filename>,
                 <filename>network.target</filename>,
                 <filename>nss-lookup.target</filename>,
+                <filename>nss-user-lookup.target</filename>,
                 <filename>poweroff.target</filename>,
+                <filename>printer.target</filename>,
                 <filename>reboot.target</filename>,
                 <filename>remote-fs.target</filename>,
                 <filename>remote-fs-pre.target</filename>,
@@ -82,7 +87,9 @@
                 <filename>shutdown.target</filename>,
                 <filename>sigpwr.target</filename>,
                 <filename>sleep.target</filename>,
+                <filename>smartcard.target</filename>,
                 <filename>sockets.target</filename>,
+                <filename>sound.target</filename>,
                 <filename>suspend.target</filename>,
                 <filename>swap.target</filename>,
                 <filename>sysinit.target</filename>,
                                 </listitem>
                         </varlistentry>
                         <varlistentry>
+                                <term><filename>bluetooth.target</filename></term>
+                                <listitem>
+                                        <para>This target is started
+                                        automatically as soon as a
+                                        bluetooth controller is
+                                        plugged in or becomes
+                                        available at boot.</para>
+                                </listitem>
+                        </varlistentry>
+                        <varlistentry>
                                 <term><filename>ctrl-alt-del.target</filename></term>
                                 <listitem>
                                         <para>systemd starts this
                                 </listitem>
                         </varlistentry>
                         <varlistentry>
+                                <term><filename>cryptsetup.target</filename></term>
+                                <listitem>
+                                        <para>A target that pulls in
+                                        setup services for all
+                                        encrypted block
+                                        devices.</para>
+                                </listitem>
+                        </varlistentry>
+                        <varlistentry>
                                 <term><filename>dbus.service</filename></term>
                                 <listitem>
                                         <para>A special unit for the
                                 </listitem>
                         </varlistentry>
                         <varlistentry>
+                                <term><filename>getty.target</filename></term>
+                                <listitem>
+                                        <para>A special target unit
+                                        that pulls in all local TTY
+                                        <filename>getty</filename> instances.
+                                        </para>
+                                </listitem>
+                        </varlistentry>
+                        <varlistentry>
                                 <term><filename>graphical.target</filename></term>
                                 <listitem>
                                         <para>A special target unit
                                 </listitem>
                         </varlistentry>
                         <varlistentry>
+                                <term><filename>printer.target</filename></term>
+                                <listitem>
+                                        <para>This target is started
+                                        automatically as soon as a
+                                        printer is plugged in or
+                                        becomes available at
+                                        boot.</para>
+                                </listitem>
+                        </varlistentry>
+                        <varlistentry>
                                 <term><filename>reboot.target</filename></term>
                                 <listitem>
                                         <para>A special target unit
                                 </listitem>
                         </varlistentry>
                         <varlistentry>
+                                <term><filename>smartcard.target</filename></term>
+                                <listitem>
+                                        <para>This target is started
+                                        automatically as soon as a
+                                        smartcard controller is
+                                        plugged in or becomes
+                                        available at boot.</para>
+                                </listitem>
+                        </varlistentry>
+                        <varlistentry>
                                 <term><filename>sockets.target</filename></term>
                                 <listitem>
                                         <para>A special target unit
                                 </listitem>
                         </varlistentry>
                         <varlistentry>
+                                <term><filename>sound.target</filename></term>
+                                <listitem>
+                                        <para>This target is started
+                                        automatically as soon as a
+                                        sound card is plugged in or
+                                        becomes available at
+                                        boot.</para>
+                                </listitem>
+                        </varlistentry>
+                        <varlistentry>
                                 <term><filename>suspend.target</filename></term>
                                 <listitem>
                                         <para>A special target unit
index c81c7a3..dbc5fed 100644 (file)
                         </varlistentry>
 
                         <varlistentry>
+                                <term><varname>Documentation=</varname></term>
+                                <listitem><para>A space separated list
+                                of URIs referencing documentation for
+                                this unit or its
+                                configuration. Accepted are only URIs
+                                of the types
+                                <literal>http://</literal>,
+                                <literal>https://</literal>,
+                                <literal>file:</literal>,
+                                <literal>info:</literal>,
+                                <literal>man:</literal>. For more
+                                information about the syntax of these
+                                URIs see
+                                <citerefentry><refentrytitle>uri</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
                                 <term><varname>Requires=</varname></term>
 
                                 <listitem><para>Configures requirement
index 834fbd7..812f1b9 100644 (file)
@@ -808,6 +808,7 @@ const BusProperty bus_unit_properties[] = {
         { "PropagateReloadTo",    bus_unit_append_dependencies,      "as", offsetof(Unit, dependencies[UNIT_PROPAGATE_RELOAD_TO]),     true },
         { "PropagateReloadFrom",  bus_unit_append_dependencies,      "as", offsetof(Unit, dependencies[UNIT_PROPAGATE_RELOAD_FROM]),   true },
         { "RequiresMountsFor",    bus_property_append_strv,          "as", offsetof(Unit, requires_mounts_for),                        true },
+        { "Documentation",        bus_property_append_strv,          "as", offsetof(Unit, documentation),                              true },
         { "Description",          bus_unit_append_description,        "s", 0 },
         { "LoadState",            bus_unit_append_load_state,         "s", offsetof(Unit, load_state)                         },
         { "ActiveState",          bus_unit_append_active_state,       "s", 0 },
index d22802d..9680b56 100644 (file)
@@ -87,6 +87,7 @@
         "  <property name=\"PropagateReloadFrom\" type=\"as\" access=\"read\"/>\n" \
         "  <property name=\"RequiresMountsFor\" type=\"as\" access=\"read\"/>\n" \
         "  <property name=\"Description\" type=\"s\" access=\"read\"/>\n" \
+        "  <property name=\"Documentation\" type=\"as\" access=\"read\"/>\n" \
         "  <property name=\"LoadState\" type=\"s\" access=\"read\"/>\n" \
         "  <property name=\"ActiveState\" type=\"s\" access=\"read\"/>\n" \
         "  <property name=\"SubState\" type=\"s\" access=\"read\"/>\n"  \
index d929273..f0e25c0 100644 (file)
@@ -92,6 +92,7 @@ $1.ControlGroupPersistent,       config_parse_tristate,              0,
 )m4_dnl
 Unit.Names,                      config_parse_unit_names,            0,                             0
 Unit.Description,                config_parse_unit_string_printf,    0,                             offsetof(Unit, description)
+Unit.Documentation,              config_parse_documentation,         0,                             offsetof(Unit, documentation)
 Unit.Requires,                   config_parse_unit_deps,             UNIT_REQUIRES,                 0
 Unit.RequiresOverridable,        config_parse_unit_deps,             UNIT_REQUIRES_OVERRIDABLE,     0
 Unit.Requisite,                  config_parse_unit_deps,             UNIT_REQUISITE,                0
index c2efec6..3bc0533 100644 (file)
@@ -2063,6 +2063,43 @@ int config_parse_unit_requires_mounts_for(
         return r;
 }
 
+int config_parse_documentation(
+                const char *filename,
+                unsigned line,
+                const char *section,
+                const char *lvalue,
+                int ltype,
+                const char *rvalue,
+                void *data,
+                void *userdata) {
+
+        Unit *u = userdata;
+        int r;
+        char **a, **b;
+
+        assert(filename);
+        assert(lvalue);
+        assert(rvalue);
+        assert(u);
+
+        r = config_parse_unit_strv_printf(filename, line, section, lvalue, ltype, rvalue, data, userdata);
+        if (r < 0)
+                return r;
+
+        for (a = b = u->documentation; a && *a; a++) {
+
+                if (is_valid_documentation_url(*a))
+                        *(b++) = *a;
+                else {
+                        log_error("[%s:%u] Invalid URL, ignoring: %s", filename, line, *a);
+                        free(*a);
+                }
+        }
+        *b = NULL;
+
+        return r;
+}
+
 #define FOLLOW_MAX 8
 
 static int open_follow(char **filename, FILE **_f, Set *names, char **_final) {
index ccc4364..3b2ed09 100644 (file)
@@ -36,6 +36,7 @@ int config_parse_unit_names(const char *filename, unsigned line, const char *sec
 int config_parse_unit_string_printf(const char *filename, unsigned line, const char *section, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
 int config_parse_unit_strv_printf(const char *filename, unsigned line, const char *section, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
 int config_parse_unit_path_printf(const char *filename, unsigned line, const char *section, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
+int config_parse_documentation(const char *filename, unsigned line, const char *section, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
 int config_parse_socket_listen(const char *filename, unsigned line, const char *section, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
 int config_parse_socket_bind(const char *filename, unsigned line, const char *section, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
 int config_parse_exec_nice(const char *filename, unsigned line, const char *section, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
index 200d196..1f1a531 100644 (file)
@@ -397,6 +397,7 @@ void unit_free(Unit *u) {
         cgroup_attribute_free_list(u->cgroup_attributes);
 
         free(u->description);
+        strv_free(u->documentation);
         free(u->fragment_path);
         free(u->instance);
 
@@ -624,7 +625,7 @@ const char *unit_description(Unit *u) {
 }
 
 void unit_dump(Unit *u, FILE *f, const char *prefix) {
-        char *t;
+        char *t, **j;
         UnitDependency d;
         Iterator i;
         char *p2;
@@ -672,6 +673,9 @@ void unit_dump(Unit *u, FILE *f, const char *prefix) {
         SET_FOREACH(t, u->names, i)
                 fprintf(f, "%s\tName: %s\n", prefix, t);
 
+        STRV_FOREACH(j, u->documentation)
+                fprintf(f, "%s\tDocumentation: %s\n", prefix, *j);
+
         if ((following = unit_following(u)))
                 fprintf(f, "%s\tFollowing: %s\n", prefix, following->id);
 
@@ -698,8 +702,6 @@ void unit_dump(Unit *u, FILE *f, const char *prefix) {
         }
 
         if (!strv_isempty(u->requires_mounts_for)) {
-                char **j;
-
                 fprintf(f,
                         "%s\tRequiresMountsFor:", prefix);
 
index e8e6b09..87dc88c 100644 (file)
@@ -157,6 +157,7 @@ struct Unit {
         char **requires_mounts_for;
 
         char *description;
+        char **documentation;
 
         char *fragment_path; /* if loaded from a config file this is the primary path to it */
         usec_t fragment_mtime;
index 0b81e1c..ae0ce32 100644 (file)
@@ -5610,3 +5610,24 @@ int can_sleep(const char *type) {
         free(p);
         return found;
 }
+
+bool is_valid_documentation_url(const char *url) {
+        assert(url);
+
+        if (startswith(url, "http://") && url[7])
+                return true;
+
+        if (startswith(url, "https://") && url[8])
+                return true;
+
+        if (startswith(url, "file:") && url[5])
+                return true;
+
+        if (startswith(url, "info:") && url[5])
+                return true;
+
+        if (startswith(url, "man:") && url[4])
+                return true;
+
+        return false;
+}
index f1bcb8a..3dce047 100644 (file)
@@ -508,4 +508,6 @@ int getenv_for_pid(pid_t pid, const char *field, char **_value);
 
 int can_sleep(const char *type);
 
+bool is_valid_documentation_url(const char *url);
+
 #endif
index 92c79d0..0d2044f 100644 (file)
@@ -2158,6 +2158,8 @@ typedef struct UnitStatusInfo {
         const char *description;
         const char *following;
 
+        char **documentation;
+
         const char *path;
         const char *default_control_group;
 
@@ -2303,6 +2305,19 @@ static void print_status_info(UnitStatusInfo *i) {
         if (i->what)
                 printf("\t    What: %s\n", i->what);
 
+        if (!strv_isempty(i->documentation)) {
+                char **t;
+                bool first = true;
+
+                STRV_FOREACH(t, i->documentation) {
+                        if (first) {
+                                printf("\t    Docs: %s\n", *t);
+                                first = false;
+                        } else
+                                printf("\t          %s\n", *t);
+                }
+        }
+
         if (i->accept)
                 printf("\tAccepted: %u; Connected: %u\n", i->n_accepted, i->n_connections);
 
@@ -2609,6 +2624,27 @@ static int status_property(const char *name, DBusMessageIter *iter, UnitStatusIn
 
                                 dbus_message_iter_next(&sub);
                         }
+                } else if (dbus_message_iter_get_element_type(iter) == DBUS_TYPE_STRING &&
+                           streq(name, "Documentation")) {
+
+                        DBusMessageIter sub;
+
+                        dbus_message_iter_recurse(iter, &sub);
+                        while (dbus_message_iter_get_arg_type(&sub) == DBUS_TYPE_STRING) {
+                                const char *s;
+                                char **l;
+
+                                dbus_message_iter_get_basic(&sub, &s);
+
+                                l = strv_append(i->documentation, s);
+                                if (!l)
+                                        return -ENOMEM;
+
+                                strv_free(i->documentation);
+                                i->documentation = l;
+
+                                dbus_message_iter_next(&sub);
+                        }
                 }
 
                 break;
@@ -2932,6 +2968,8 @@ static int show_one(const char *verb, DBusConnection *bus, const char *path, boo
         if (!show_properties)
                 print_status_info(&info);
 
+        strv_free(info.documentation);
+
         if (!streq_ptr(info.active_state, "active") &&
             !streq_ptr(info.active_state, "reloading") &&
             streq(verb, "status"))
index c3c7ced..f9d03fa 100644 (file)
@@ -5,10 +5,9 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Basic System
+Documentation=man:systemd.special(7)
 Requires=sysinit.target sockets.target
 After=sysinit.target sockets.target
 RefuseManualStart=yes
index 6b9b5b5..dd4ae14 100644 (file)
@@ -5,8 +5,7 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Bluetooth
+Documentation=man:systemd.special(7)
 StopWhenUnneeded=yes
index af38e5d..25d3e33 100644 (file)
@@ -5,7 +5,6 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Encrypted Volumes
+Documentation=man:systemd.special(7)
index fcc5073..9381167 100644 (file)
@@ -7,6 +7,7 @@
 
 [Unit]
 Description=Huge Pages File System
+Documentation=https://www.kernel.org/doc/Documentation/vm/hugetlbpage.txt
 DefaultDependencies=no
 Before=sysinit.target
 ConditionPathExists=/sys/kernel/mm/hugepages
index a55ac93..5786bb1 100644 (file)
@@ -7,6 +7,7 @@
 
 [Unit]
 Description=POSIX Message Queue File System
+Documentation=man:mq_overview(7)
 DefaultDependencies=no
 Before=sysinit.target
 ConditionPathExists=/proc/sys/fs/mqueue
index 7500756..87864f1 100644 (file)
@@ -5,8 +5,6 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Emergency Shell
 DefaultDependencies=no
index 791dbe5..0760d66 100644 (file)
@@ -5,10 +5,9 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Emergency Mode
+Documentation=man:systemd.special(7)
 Requires=emergency.service
 After=emergency.service
 AllowIsolate=yes
index d516f38..4281910 100644 (file)
@@ -5,10 +5,9 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Final Step
+Documentation=man:systemd.special(7)
 DefaultDependencies=no
 RefuseManualStart=yes
 After=shutdown.target umount.target
index f1c926c..d53da35 100644 (file)
@@ -7,3 +7,4 @@
 
 [Unit]
 Description=Login Prompts
+Documentation=man:systemd.special(7)
index 431a3dd..6d45836 100644 (file)
@@ -7,6 +7,7 @@
 
 [Unit]
 Description=Getty on %I
+Documentation=man:agetty(8)
 After=systemd-user-sessions.service plymouth-quit-wait.service
 m4_ifdef(`TARGET_FEDORA',
 After=rc-local.service
index 2e82d6f..7c6ebd4 100644 (file)
@@ -5,10 +5,9 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Graphical Interface
+Documentation=man:systemd.special(7)
 Requires=multi-user.target
 After=multi-user.target
 Conflicts=rescue.target
index dc90880..41266b9 100644 (file)
@@ -5,10 +5,9 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Halt
+Documentation=man:systemd.special(7)
 DefaultDependencies=no
 Requires=halt.service
 After=halt.service
index 05238a7..23a9f99 100644 (file)
@@ -5,10 +5,9 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Hibernate
+Documentation=man:systemd.special(7)
 DefaultDependencies=no
 BindTo=hibernate.service
 After=hibernate.service
index 1de1ec4..21ce997 100644 (file)
@@ -5,10 +5,9 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 # This exists mostly for compatibility with SysV/LSB units, and
 # implementations lacking socket/bus activation.
 
 [Unit]
 Description=Web Server
+Documentation=man:systemd.special(7)
index 4941f51..be8eafc 100644 (file)
@@ -5,10 +5,9 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Reboot via kexec
+Documentation=man:systemd.special(7)
 DefaultDependencies=no
 Requires=kexec.service
 After=kexec.service
index a928c1d..f8760ec 100644 (file)
@@ -5,7 +5,6 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Local File Systems (Pre)
+Documentation=man:systemd.special(7)
index 2aa51fc..dd92b17 100644 (file)
@@ -5,9 +5,8 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Local File Systems
+Documentation=man:systemd.special(7)
 OnFailure=emergency.target
 OnFailureIsolate=yes
index 94d134e..d2f24d1 100644 (file)
@@ -5,10 +5,9 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 # This exists mostly for compatibility with SysV/LSB units, and
 # implementations lacking socket/bus activation.
 
 [Unit]
 Description=Mail Transfer Agent
+Documentation=man:systemd.special(7)
index fe19cbc..6e3f0b4 100644 (file)
@@ -5,10 +5,9 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Multi-User
+Documentation=man:systemd.special(7)
 Requires=basic.target
 Conflicts=rescue.service rescue.target
 After=basic.target rescue.service rescue.target
index da800da..5406f4e 100644 (file)
@@ -5,7 +5,6 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Network
+Documentation=man:systemd.special(7)
index c2d605c..eea905a 100644 (file)
@@ -5,11 +5,10 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 # This exists mostly for compatibility with SysV/LSB units, and
 # implementations lacking socket/bus activation.
 
 [Unit]
 Description=Host and Network Name Lookups
+Documentation=man:systemd.special(7)
 After=network.target
index 0053f06..3e0fced 100644 (file)
@@ -5,11 +5,10 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 # This exists mostly for implementations lacking socket/bus
 # activation.
 
 [Unit]
 Description=User and Group Name Lookups
+Documentation=man:systemd.special(7)
 After=network.target
index b81d6ee..bb60c33 100644 (file)
@@ -5,10 +5,9 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Power-Off
+Documentation=man:systemd.special(7)
 DefaultDependencies=no
 Requires=poweroff.service
 After=poweroff.service
index b8582da..a6b86ca 100644 (file)
@@ -5,8 +5,7 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Printer
+Documentation=man:systemd.special(7)
 StopWhenUnneeded=yes
index ff958ca..c64c849 100644 (file)
@@ -7,6 +7,7 @@
 
 [Unit]
 Description=Arbitrary Executable File Formats File System
+Documentation=https://www.kernel.org/doc/Documentation/binfmt_misc.txt
 DefaultDependencies=no
 
 [Mount]
index 6d02417..9faeb18 100644 (file)
@@ -5,10 +5,9 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Reboot
+Documentation=man:systemd.special(7)
 DefaultDependencies=no
 Requires=reboot.service
 After=reboot.service
index 8f688ad..2169533 100644 (file)
@@ -5,8 +5,7 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Remote File Systems (Pre)
+Documentation=man:systemd.special(7)
 After=network.target nss-lookup.target
index 87455a4..9e68878 100644 (file)
@@ -5,10 +5,9 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Remote File Systems
+Documentation=man:systemd.special(7)
 
 [Install]
 WantedBy=multi-user.target
index 3adfcf4..75b9fde 100644 (file)
@@ -5,8 +5,6 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Rescue Shell
 DefaultDependencies=no
index 85099a1..c17a4e1 100644 (file)
@@ -5,10 +5,9 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Rescue Mode
+Documentation=man:systemd.special(7)
 Requires=basic.target rescue.service
 After=basic.target rescue.service
 AllowIsolate=yes
index 5a286eb..eb06a6d 100644 (file)
@@ -5,10 +5,9 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 # This exists mostly for compatibility with SysV/LSB units, and
 # implementations lacking socket/bus activation.
 
 [Unit]
 Description=RPC Port Mapper
+Documentation=man:systemd.special(7)
index 366b2d0..d61f93c 100644 (file)
@@ -7,6 +7,7 @@
 
 [Unit]
 Description=Serial Getty on %I
+Documentation=man:agetty(8)
 BindTo=dev-%i.device
 After=dev-%i.device systemd-user-sessions.service plymouth-quit-wait.service
 m4_ifdef(`TARGET_FEDORA',
index 1bbef68..73e302b 100644 (file)
@@ -5,9 +5,8 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Shutdown
+Documentation=man:systemd.special(7)
 DefaultDependencies=no
 RefuseManualStart=yes
index 18a9683..a52e7cf 100644 (file)
@@ -5,7 +5,6 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Power Failure
+Documentation=man:systemd.special(7)
index 9f4b247..d7ebd28 100644 (file)
@@ -5,9 +5,8 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Sleep
+Documentation=man:systemd.special(7)
 DefaultDependencies=no
 RefuseManualStart=yes
index 3e554a0..5fefe84 100644 (file)
@@ -5,8 +5,7 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Smart Card
+Documentation=man:systemd.special(7)
 StopWhenUnneeded=yes
index ab1b786..26ab065 100644 (file)
@@ -5,7 +5,6 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Sockets
+Documentation=man:systemd.special(7)
index 6a17360..6699ade 100644 (file)
@@ -5,8 +5,7 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Sound Card
+Documentation=man:systemd.special(7)
 StopWhenUnneeded=yes
index 3ddb449..eaf79be 100644 (file)
@@ -5,10 +5,9 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Suspend
+Documentation=man:systemd.special(7)
 DefaultDependencies=no
 BindTo=suspend.service
 After=suspend.service
index 4e16542..23a7d0d 100644 (file)
@@ -5,7 +5,6 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Swap
+Documentation=man:systemd.special(7)
index 5bc568f..8f4fb8f 100644 (file)
@@ -5,10 +5,9 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=System Initialization
+Documentation=man:systemd.special(7)
 Conflicts=emergency.service emergency.target
 Wants=local-fs.target swap.target
 After=local-fs.target swap.target emergency.service emergency.target
index f644f6e..a228e5b 100644 (file)
@@ -5,10 +5,10 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Syslog Socket
+Documentation=man:systemd.special(7)
+Documentation=http://www.freedesktop.org/wiki/Software/systemd/syslog
 DefaultDependencies=no
 Before=sockets.target syslog.target
 Conflicts=shutdown.target
index 92d2576..87ac886 100644 (file)
@@ -5,13 +5,13 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 # This exists mostly for compatibility with SysV/LSB units, and
 # implementations lacking socket/bus activation.
 
 [Unit]
 Description=Syslog
+Documentation=man:systemd.special(7)
+Documentation=http://www.freedesktop.org/wiki/Software/systemd/syslog
 
 # Avoid that we conflict with shutdown.target, so that we can stay
 # until the very end and do not cancel shutdown.target if we should
index dc8ab32..a0a3631 100644 (file)
@@ -7,6 +7,7 @@
 
 [Unit]
 Description=Dispatch Password Requests to Console Directory Watch
+Documentation=http://www.freedesktop.org/wiki/Software/systemd/PasswordAgents
 DefaultDependencies=no
 Conflicts=shutdown.target
 After=plymouth-start.service
index 55e3d86..85e739f 100644 (file)
@@ -7,6 +7,7 @@
 
 [Unit]
 Description=Dispatch Password Requests to Console
+Documentation=http://www.freedesktop.org/wiki/Software/systemd/PasswordAgents
 DefaultDependencies=no
 Conflicts=shutdown.target
 After=plymouth-start.service
index b938ae5..9320b4a 100644 (file)
@@ -7,6 +7,7 @@
 
 [Unit]
 Description=Forward Password Requests to Plymouth Directory Watch
+Documentation=http://www.freedesktop.org/wiki/Software/systemd/PasswordAgents
 DefaultDependencies=no
 Conflicts=shutdown.target
 After=plymouth-start.service
index fcc2853..ea80bbd 100644 (file)
@@ -7,6 +7,7 @@
 
 [Unit]
 Description=Forward Password Requests to Plymouth
+Documentation=http://www.freedesktop.org/wiki/Software/systemd/PasswordAgents
 DefaultDependencies=no
 Conflicts=shutdown.target
 After=plymouth-start.service
index 73e1361..3890a74 100644 (file)
@@ -7,6 +7,7 @@
 
 [Unit]
 Description=Forward Password Requests to Wall Directory Watch
+Documentation=http://www.freedesktop.org/wiki/Software/systemd/PasswordAgents
 DefaultDependencies=no
 Conflicts=shutdown.target
 Before=basic.target shutdown.target
index 1db408e..9305fca 100644 (file)
@@ -7,6 +7,7 @@
 
 [Unit]
 Description=Forward Password Requests to Wall
+Documentation=http://www.freedesktop.org/wiki/Software/systemd/PasswordAgents
 After=systemd-user-sessions.service
 
 [Service]
index 8d28806..a7cda97 100644 (file)
@@ -7,6 +7,8 @@
 
 [Unit]
 Description=Set Up Additional Binary Formats
+Documentation=man:binfmt.d(5)
+Documentation=https://www.kernel.org/doc/Documentation/binfmt_misc.txt
 DefaultDependencies=no
 Conflicts=shutdown.target
 After=systemd-readahead-collect.service systemd-readahead-replay.service proc-sys-fs-binfmt_misc.automount
index a9a9913..d7fd194 100644 (file)
@@ -5,10 +5,11 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Hostname Service
+Documentation=man:hostname(5)
+Documentation=man:machine-info(5)
+Documentation=http://www.freedesktop.org/wiki/Software/systemd/hostnamed
 
 [Service]
 ExecStart=@rootlibexecdir@/systemd-hostnamed
index bcadcc8..11e2286 100644 (file)
@@ -5,8 +5,6 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=/dev/initctl Compatibility Daemon
 DefaultDependencies=no
index 66597ee..abafc52 100644 (file)
@@ -5,8 +5,6 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=/dev/initctl Compatibility Named Pipe
 DefaultDependencies=no
index a3c22c8..da07cb9 100644 (file)
@@ -5,10 +5,9 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Journal Service
+Documentation=man:journald.conf(5)
 DefaultDependencies=no
 Requires=systemd-journald.socket
 After=systemd-journald.socket
index d613e22..0454e3e 100644 (file)
@@ -5,10 +5,9 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Journal Socket
+Documentation=man:journald.conf(5)
 DefaultDependencies=no
 Before=sockets.target syslog.target
 
index 763d290..f973fa4 100644 (file)
@@ -5,10 +5,11 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Locale Service
+Documentation=http://www.freedesktop.org/wiki/Software/systemd/localed
+Documentation=man:locale.conf(5)
+Documentation=man:vconsole.conf(5)
 
 [Service]
 ExecStart=@rootlibexecdir@/systemd-localed
index f244761..d890713 100644 (file)
@@ -5,10 +5,10 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Login Service
+Documentation=http://www.freedesktop.org/wiki/Software/systemd/multiseat
+Documentation=man:logind.conf(5)
 After=nss-user-lookup.target
 
 [Service]
index 243afad..8f25091 100644 (file)
@@ -7,6 +7,7 @@
 
 [Unit]
 Description=Load Kernel Modules
+Documentation=man:modules-load.d(5)
 DefaultDependencies=no
 Conflicts=shutdown.target
 After=systemd-readahead-collect.service systemd-readahead-replay.service
index ec88b23..b9e271f 100644 (file)
@@ -5,8 +5,6 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Delayed Shutdown Service
 DefaultDependencies=no
index c97e01a..ed6225a 100644 (file)
@@ -5,8 +5,6 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Delayed Shutdown Socket
 DefaultDependencies=no
index d38f026..d8849e7 100644 (file)
@@ -7,6 +7,7 @@
 
 [Unit]
 Description=Apply Kernel Variables
+Documentation=man:sysctl.d(5)
 DefaultDependencies=no
 Conflicts=shutdown.target
 After=systemd-readahead-collect.service systemd-readahead-replay.service
index 1284248..0837004 100644 (file)
@@ -12,6 +12,7 @@
 
 [Unit]
 Description=Network Time Protocol
+Documentation=http://www.freedesktop.org/wiki/Software/systemd/timedated
 
 [Install]
 WantedBy=multi-user.target
index 0122283..fbdf9e1 100644 (file)
@@ -5,10 +5,10 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Time & Date Service
+Documentation=http://www.freedesktop.org/wiki/Software/systemd/timedated
+Documentation=man:timezone(5)
 
 [Service]
 ExecStart=@rootlibexecdir@/systemd-timedated
index 0a8707e..a288232 100644 (file)
@@ -7,6 +7,7 @@
 
 [Unit]
 Description=Cleanup of Temporary Directories
+Documentation=man:tmpfiles.d(5)
 DefaultDependencies=no
 Wants=local-fs.target
 After=systemd-readahead-collect.service systemd-readahead-replay.service local-fs.target
index c9f89e8..fac4ee3 100644 (file)
@@ -7,6 +7,7 @@
 
 [Unit]
 Description=Daily Cleanup of Temporary Directories
+Documentation=man:tmpfiles.d(5)
 
 [Timer]
 OnBootSec=15min
index 58c3415..dbd6bfb 100644 (file)
@@ -7,6 +7,7 @@
 
 [Unit]
 Description=Recreate Volatile Files and Directories
+Documentation=man:tmpfiles.d(5)
 DefaultDependencies=no
 Wants=local-fs.target
 After=systemd-readahead-collect.service systemd-readahead-replay.service local-fs.target
index 1cf0683..dc5e1da 100644 (file)
@@ -1,5 +1,14 @@
+#  This file is part of systemd.
+#
+#  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
+#  the Free Software Foundation; either version 2.1 of the License, or
+#  (at your option) any later version.
+
 [Unit]
 Description=udev Control Socket
+Documentation=man:udev(7)
+Documentation=man:udevd(8)
 DefaultDependencies=no
 ConditionCapability=CAP_MKNOD
 
index 8f2690f..3270fe8 100644 (file)
@@ -1,5 +1,14 @@
+#  This file is part of systemd.
+#
+#  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
+#  the Free Software Foundation; either version 2.1 of the License, or
+#  (at your option) any later version.
+
 [Unit]
 Description=udev Kernel Socket
+Documentation=man:udev(7)
+Documentation=man:udevd(8)
 DefaultDependencies=no
 ConditionCapability=CAP_MKNOD
 
index e8c9223..b782d73 100644 (file)
@@ -1,3 +1,10 @@
+#  This file is part of systemd.
+#
+#  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
+#  the Free Software Foundation; either version 2.1 of the License, or
+#  (at your option) any later version.
+
 # This service is usually not enabled by default. If enabled, it
 # acts as a barrier for basic.target -- so all later services will
 # wait for udev completely finishing its coldplug run.
@@ -10,6 +17,8 @@
 
 [Unit]
 Description=udev Wait for Complete Device Initialization
+Documentation=man:udev(7)
+Documentation=man:udevd(8)
 DefaultDependencies=no
 Wants=systemd-udev.service
 After=udev-trigger.service
index 523dd47..61d188e 100644 (file)
@@ -1,5 +1,14 @@
+#  This file is part of systemd.
+#
+#  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
+#  the Free Software Foundation; either version 2.1 of the License, or
+#  (at your option) any later version.
+
 [Unit]
 Description=udev Coldplug all Devices
+Documentation=man:udev(7)
+Documentation=man:udevd(8)
 Wants=systemd-udev.service
 After=systemd-udev-kernel.socket systemd-udev-control.socket
 DefaultDependencies=no
index 8a17933..7bd8e3c 100644 (file)
@@ -1,5 +1,14 @@
+#  This file is part of systemd.
+#
+#  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
+#  the Free Software Foundation; either version 2.1 of the License, or
+#  (at your option) any later version.
+
 [Unit]
 Description=udev Kernel Device Manager
+Documentation=man:udev(7)
+Documentation=man:udevd(8)
 Wants=systemd-udev-control.socket systemd-udev-kernel.socket
 After=systemd-udev-control.socket systemd-udev-kernel.socket
 Before=basic.target
index 2a0751e..6666dbd 100644 (file)
@@ -7,6 +7,7 @@
 
 [Unit]
 Description=Update UTMP about System Runlevel Changes
+Documentation=man:utmp(5)
 DefaultDependencies=no
 After=local-fs.target sysinit.target auditd.service runlevel1.target runlevel2.target runlevel3.target runlevel4.target runlevel5.target systemd-tmpfiles-setup.service
 Before=poweroff.service reboot.service halt.service
index e86c770..5b726c3 100644 (file)
@@ -7,6 +7,7 @@
 
 [Unit]
 Description=Update UTMP about System Shutdown
+Documentation=man:utmp(5)
 DefaultDependencies=no
 After=local-fs.target sysinit.target auditd.service systemd-update-utmp-runlevel.service
 Before=poweroff.service reboot.service halt.service
index 1420ce8..51fc0b5 100644 (file)
@@ -7,6 +7,7 @@
 
 [Unit]
 Description=Setup Virtual Console
+Documentation=man:vconsole.conf(5)
 DefaultDependencies=no
 Conflicts=shutdown.target
 After=systemd-readahead-collect.service systemd-readahead-replay.service
index 36b9e7a..ec00ecb 100644 (file)
@@ -5,10 +5,9 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 # This exists mostly for compatibility with SysV/LSB units, and
 # implementations lacking socket/bus activation.
 
 [Unit]
 Description=System Time Synchronized
+Documentation=man:systemd.special(7)
index c583062..39668d8 100644 (file)
@@ -5,9 +5,8 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Unmount All Filesystems
+Documentation=man:systemd.special(7)
 DefaultDependencies=no
 RefuseManualStart=yes
index 4f9379e..56cf4dc 100644 (file)
@@ -5,7 +5,6 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Default
+Documentation=man:systemd.special(7)
index c785fbd..a114f6c 100644 (file)
@@ -5,10 +5,9 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Exit the Session
+Documentation=man:systemd.special(7)
 DefaultDependencies=no
 Requires=shutdown.target
 After=shutdown.target
index ffc8fad..539e03a 100644 (file)
@@ -5,10 +5,9 @@
 #  the Free Software Foundation; either version 2.1 of the License, or
 #  (at your option) any later version.
 
-# See systemd.special(7) for details
-
 [Unit]
 Description=Exit the Session
+Documentation=man:systemd.special(7)
 DefaultDependencies=no
 Requires=exit.service
 After=exit.service