From: Michael Stapelberg <stapelberg@debian.org>
Date: Mon, 12 Aug 2013 19:59:41 +0000 (+0200)
Subject: systemd.unit(5): clarify the Description= contents
X-Git-Tag: v207~131
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=commitdiff_plain;h=693093c6db9d8510729b7566e74182b4ff50e31c

systemd.unit(5): clarify the Description= contents
---

diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml
index c6325d373..17141576d 100644
--- a/man/systemd.unit.xml
+++ b/man/systemd.unit.xml
@@ -359,7 +359,15 @@
                                 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>