From 49dbfa7b2b0bf3906704dac1eaeb4eba91056a19 Mon Sep 17 00:00:00 2001
From: Lennart Poettering <lennart@poettering.net>
Date: Mon, 21 May 2012 15:12:18 +0200
Subject: units: introduce new Documentation= field and make use of it
 everywhere

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.
---
 man/systemd.unit.xml | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

(limited to 'man/systemd.unit.xml')

diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml
index c81c7a30b0..dbc5fedea9 100644
--- a/man/systemd.unit.xml
+++ b/man/systemd.unit.xml
@@ -294,6 +294,23 @@
                                 name.</para></listitem>
                         </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>
 
-- 
cgit v1.2.3-54-g00ecf