chiark / gitweb /
systemd.unit(5): clarify the Description= contents
authorMichael Stapelberg <stapelberg@debian.org>
Mon, 12 Aug 2013 19:59:41 +0000 (21:59 +0200)
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Thu, 15 Aug 2013 02:38:09 +0000 (22:38 -0400)
man/systemd.unit.xml

index c6325d3..1714157 100644 (file)
                                 describing the unit. This is intended
                                 for use in UIs to show descriptive
                                 information along with the unit
-                                name.</para></listitem>
+                                name. The description should contain a name
+                                that means something to the end user.
+                                <literal>Apache2 Web Server</literal> is a good
+                                example. Bad examples are
+                                <literal>high-performance light-weight HTTP
+                                server</literal> (too generic) or
+                                <literal>Apache2</literal> (too specific and
+                                meaningless for people who do not know
+                                Apache).</para></listitem>
                         </varlistentry>
 
                         <varlistentry>