From c43acf69e4eadd03f4a7c00eb1a88d8c52b43490 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Thu, 22 Nov 2018 17:05:33 +0100 Subject: [PATCH] man: update description of Description= The way this is used drifted a bit from the original intent. Let's update the description and add some examples to inspire people to texts that look less bad during initial boot. --- man/systemd.unit.xml | 24 +++++++++++++++--------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml index 6b7022f35e9..be77e722907 100644 --- a/man/systemd.unit.xml +++ b/man/systemd.unit.xml @@ -502,15 +502,21 @@ Description= - A free-form string describing the unit. This - is intended for use in UIs to show descriptive information - along with the unit name. The description should contain a - name that means something to the end user. Apache2 - Web Server is a good example. Bad examples are - high-performance light-weight HTTP server - (too generic) or Apache2 (too specific and - meaningless for people who do not know - Apache). + A human readable name for the unit. This is used by + systemd (and other UIs) as the label for the unit, so this string should + identify the unit rather than describe it, despite the name. Apache2 Web + Server is a good example. Bad examples are high-performance light-weight + HTTP server (too generic) or Apache2 (too specific and + meaningless for people who do not know Apache). systemd will use this + string as a noun in status messages (Starting + description..., Started + description., Reached target + description., Failed to start + description.), so it should be capitalized, and should + not be a full sentence or a phrase with a continous verb. Bad examples include + exiting the container or updating the database once per + day.. + -- 2.47.3