chiark / gitweb /
man: document that Documentation= follows an order
[elogind.git] / man / systemd.unit.xml
index afad56c5b2ef4bc1429423517093620a2c06be65..c20efe5527500232c288ede37fb460ee372d48fb 100644 (file)
@@ -75,7 +75,7 @@
                 inspired by Microsoft Windows
                 <filename>.ini</filename> files.</para>
 
-                <para>This man pages lists the common configuration
+                <para>This man page lists the common configuration
                 options of all the unit types. These options need to
                 be configured in the [Unit] or [Install]
                 sections of the unit files.</para>
                                 <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>