os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Add guidelines for when to add a pkg-message.

Browse source 
Submitted by:	adamw
Reviewed by:	adamw, bapt
Differential Revision:	https://reviews.freebsd.org/D20578
This commit is contained in:
Mathieu Arnold 2019-06-11 13:00:57 +00:00
parent cd1b8644d9
commit 2ca63032dd
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=53135
1 changed files with 19 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
en_US.ISO8859-1/books/porters-handbook/pkg-files/chapter.xml
View file

@ -18,11 +18,26 @@
<sect1 xml:id="porting-message">
<title><filename>pkg-message</filename></title>
<para>To display a message when the package is installed,
place the message in <filename>pkg-message</filename>. This
<para>To display a message when the package is installed, place
the message in <filename>pkg-message</filename>. This
capability is often useful to display additional installation
steps to be taken after a <command>pkg install</command> or to
display licensing information.</para>
steps to be taken after a <command>pkg install</command> or
<command>pkg upgrade</command>.</para>
<important>
<para><filename>pkg-message</filename> must contain only
information that is <emphasis>vital</emphasis> to setup and
operation on &os;, and that is unique to the port in
question.</para>
<para>Setup information should only be shown on initial install.
Upgrade instructions should be shown only when upgrading from
the relevant version.</para>
<para>Committers have blanket approval to constrain existing
messages to install or upgrade ranges using the
<acronym>UCL</acronym> format specifications.</para>
</important>
<para>pkg-message supports two formats:</para>