summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Stapelberg <stapelberg@debian.org>2013-08-12 21:59:41 +0200
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2013-08-14 22:38:09 -0400
commit693093c6db9d8510729b7566e74182b4ff50e31c (patch)
treecdbef4e607e80002eac58bdc0a76f2ea5f4f1eab
parent01264ad1cc27ecaa059857429ed1b4f3994b26c3 (diff)
systemd.unit(5): clarify the Description= contents
-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 c6325d373a..17141576d0 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>