Add notes in various places about the policy to not start or stop services.

Sponsored by:	Absolight
Differential Revision:	https://reviews.freebsd.org/D16034
This commit is contained in:
Mathieu Arnold 2018-06-27 13:58:42 +00:00
parent 1b9e24dc66
commit 08e2eb8037
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=51913
3 changed files with 33 additions and 0 deletions

View file

@ -63,6 +63,14 @@
mode the script is being run in. The <envar>PKG_PREFIX</envar>
environmental variable will be set to the package installation
directory.</para>
<important>
<para>This script is here to help you set up the package so that
it is as ready to use as possible. It <emphasis>must
not</emphasis> be abused to start services, stop services,
or any other commands that will modify the currenly running
system.</para>
</important>
</sect1>
<sect1 xml:id="pkg-deinstall">
@ -80,6 +88,14 @@
mode the script is being run in. The <envar>PKG_PREFIX</envar>
environmental variable will be set to the package installation
directory</para>
<important>
<para>This script is here to help you set up the package so that
it is as ready to use as possible. It <emphasis>must
not</emphasis> be abused to start services, stop services,
or any other commands that will modify the currenly running
system.</para>
</important>
</sect1>
<sect1 xml:id="pkg-names">

View file

@ -661,6 +661,14 @@ PLIST_SUB= PERL_ARCH=mach</programlisting>
</listitem>
</varlistentry>
</variablelist>
<important>
<para>These keywords are here to help you set up the package
so that it is as ready to use as possible. They
<emphasis>must not</emphasis> be abused to start services,
stop services, or any other commands that will modify the
currenly running system.</para>
</important>
</sect3>
<sect3 xml:id="plist-keywords-base-mode">

View file

@ -5561,6 +5561,15 @@ run_rc_command "$1"</programlisting>
<literal>_enable</literal> variable is not optional,
and must use the &quot;:&quot; for the default.</para>
<important>
<para>Ports <emphasis>must not</emphasis> start and stop
themselves when installing and deinstalling. Do not abuse the
<filename>plist</filename> keywords described in <xref
linkend="plist-keywords-base-exec"/> to run commands
starting services, stopping services, or any other commands
that will modify the currenly running system.</para>
</important>
<sect2 xml:id="rc-scripts-checklist">
<title>Pre-Commit Checklist</title>