summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2012-10-31 00:06:08 +0100
committerLennart Poettering <lennart@poettering.net>2012-10-31 00:13:55 +0100
commitf8a2ebbc503c23210300ade56c1fb71c85c40a59 (patch)
tree2e32c01be5e2ef88b0ad1fad7d904a4bc87f1368
parentc55b1b59b837dfd924b704d457ed77c55f8bfeab (diff)
man: document that Documentation= follows an order
-rw-r--r--man/systemd.unit.xml10
1 files changed, 9 insertions, 1 deletions
diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml
index f23aad9fa0..c20efe5527 100644
--- a/man/systemd.unit.xml
+++ b/man/systemd.unit.xml
@@ -338,7 +338,15 @@
<literal>man:</literal>. For more
information about the syntax of these
URIs see
- <citerefentry><refentrytitle>uri</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para></listitem>
+ <citerefentry><refentrytitle>uri</refentrytitle><manvolnum>7</manvolnum></citerefentry>. The
+ URIs should be listed in order of
+ relevance, starting with the most
+ relevant. It is a good idea to first
+ reference documentation that explains
+ what the unit's purpose is, followed
+ by how it is configured, followed by
+ any other related
+ documentation.</para></listitem>
</varlistentry>
<varlistentry>