Bug#835520: [PATCH 11/11] Drop entire section 9.4 Console messages from init.d scripts
The entire section is specific to sysvinit and already solved
by LSB in that case. There's no point in reinventing LSB.
Also other init systems handles this in ways that's not at all
described here. Just drop the entire section as it gives no
practical useful information.
---
policy.sgml | 196 ------------------------------------------------------------
1 file changed, 196 deletions(-)
diff --git a/policy.sgml b/policy.sgml
index a416e53..a486cee 100644
--- a/policy.sgml
+++ b/policy.sgml
@@ -7790,202 +7790,6 @@ test -f <var>program-executed-later-in-script</var> || exit 0
</sect1>
</sect>
- <sect>
- <heading>Console messages from <file>init.d</file> scripts</heading>
-
- <p>
- This section describes the formats to be used for messages
- written to standard output by the <file>/etc/init.d</file>
- scripts. The intent is to improve the consistency of
- Debian's startup and shutdown look and feel. For this
- reason, please look very carefully at the details. We want
- the messages to have the same format in terms of wording,
- spaces, punctuation and case of letters.
- </p>
-
- <p>
- Here is a list of overall rules that should be used for
- messages generated by <file>/etc/init.d</file> scripts.
- </p>
-
- <p>
- <list>
- <item>
- The message should fit in one line (fewer than 80
- characters), start with a capital letter and end with
- a period (<tt>.</tt>) and line feed (<tt>"\n"</tt>).
- </item>
-
- <item>
- If the script is performing some time consuming task in
- the background (not merely starting or stopping a
- program, for instance), an ellipsis (three dots:
- <tt>...</tt>) should be output to the screen, with no
- leading or tailing whitespace or line feeds.
- </item>
-
- <item>
- The messages should appear as if the computer is telling
- the user what it is doing (politely :-), but should not
- mention "it" directly. For example, instead of:
- <example compact="compact">
-I'm starting network daemons: nfsd mountd.
- </example>
- the message should say
- <example compact="compact">
-Starting network daemons: nfsd mountd.
- </example>
- </item>
- </list>
- </p>
-
- <p>
- <tt>init.d</tt> script should use the following standard
- message formats for the situations enumerated below.
- </p>
-
- <p>
- <list>
- <item>
- <p>When daemons are started</p>
-
- <p>
- If the script starts one or more daemons, the output
- should look like this (a single line, no leading
- spaces):
- <example compact="compact">
-Starting <var>description</var>: <var>daemon-1</var> ... <var>daemon-n</var>.
- </example>
- The <var>description</var> should describe the
- subsystem the daemon or set of daemons are part of,
- while <var>daemon-1</var> up to <var>daemon-n</var>
- denote each daemon's name (typically the file name of
- the program).
- </p>
-
- <p>
- For example, the output of <file>/etc/init.d/lpd</file>
- would look like:
- <example compact="compact">
-Starting printer spooler: lpd.
- </example>
- </p>
-
- <p>
- This can be achieved by saying
- <example compact="compact">
-echo -n "Starting printer spooler: lpd"
-start-stop-daemon --start --quiet --exec /usr/sbin/lpd
-echo "."
- </example>
- in the script. If there are more than one daemon to
- start, the output should look like this:
- <example compact="compact">
-echo -n "Starting remote file system services:"
-echo -n " nfsd"; start-stop-daemon --start --quiet nfsd
-echo -n " mountd"; start-stop-daemon --start --quiet mountd
-echo -n " ugidd"; start-stop-daemon --start --quiet ugidd
-echo "."
- </example>
- This makes it possible for the user to see what is
- happening and when the final daemon has been started.
- Care should be taken in the placement of white spaces:
- in the example above the system administrators can
- easily comment out a line if they don't want to start
- a specific daemon, while the displayed message still
- looks good.
- </p>
- </item>
-
- <item>
- <p>When a system parameter is being set</p>
-
- <p>
- If you have to set up different system parameters
- during the system boot, you should use this format:
- <example compact="compact">
-Setting <var>parameter</var> to "<var>value</var>".
- </example>
- </p>
-
- <p>
- You can use a statement such as the following to get
- the quotes right:
- <example compact="compact">
-echo "Setting DNS domainname to \"$domainname\"."
- </example>
- </p>
-
- <p>
- Note that the same symbol (<tt>"</tt>) <!-- " --> is used
- for the left and right quotation marks. A grave accent
- (<tt>`</tt>) is not a quote character; neither is an
- apostrophe (<tt>'</tt>).
- </p>
- </item>
-
- <item>
- <p>When a daemon is stopped or restarted</p>
-
- <p>
- When you stop or restart a daemon, you should issue a
- message identical to the startup message, except that
- <tt>Starting</tt> is replaced with <tt>Stopping</tt>
- or <tt>Restarting</tt> respectively.
- </p>
-
- <p>
- For example, stopping the printer daemon will look like
- this:
- <example compact="compact">
-Stopping printer spooler: lpd.
- </example>
- </p>
- </item>
-
- <item>
- <p>When something is executed</p>
-
- <p>
- There are several examples where you have to run a
- program at system startup or shutdown to perform a
- specific task, for example, setting the system's clock
- using <prgn>netdate</prgn> or killing all processes
- when the system shuts down. Your message should look
- like this:
- <example compact="compact">
-Doing something very useful...done.
- </example>
- You should print the <tt>done.</tt> immediately after
- the job has been completed, so that the user is
- informed why they have to wait. You can get this
- behavior by saying
- <example compact="compact">
-echo -n "Doing something very useful..."
-do_something
-echo "done."
- </example>
- in your script.
- </p>
- </item>
-
- <item>
- <p>When the configuration is reloaded</p>
-
- <p>
- When a daemon is forced to reload its configuration
- files you should use the following format:
- <example compact="compact">
-Reloading <var>description</var> configuration...done.
- </example>
- where <var>description</var> is the same as in the
- daemon starting message.
- </p>
- </item>
- </list>
- </p>
- </sect>
-
<sect id="cron-jobs">
<heading>Cron jobs</heading>
--
2.10.2
Reply to: