Hi,
Lennart, as discussed during DebConf earlier today, this patch clarifies
what should go into the Description= field. Please merge it :).
--
Best regards,
Michael
>From fef7d55294b3b407eb6513a31f4087ff84a1f20e Mon Sep 17 00:00:00 2001
From: Michael Stapelberg <[email protected]>
Date: Mon, 12 Aug 2013 21:56:52 +0200
Subject: [PATCH] systemd.unit(5): clarify the Description= contents
---
man/systemd.unit.xml | 10 +++++++++-
1 file changed, 9 insertions(+), 1 deletion(-)
diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml
index c6325d3..1714157 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>
--
1.7.10.4
_______________________________________________
systemd-devel mailing list
[email protected]
http://lists.freedesktop.org/mailman/listinfo/systemd-devel
