Differential D40217 Diff 122316 documentation/content/en/books/porters-handbook/pkg-files/_index.adoc

Changeset View

Standalone View

documentation/content/en/books/porters-handbook/pkg-files/_index.adoc

	Show First 20 Lines • Show All 58 Lines • ▼ Show 20 Lines
	====			====
	* [.filename]#pkg-message# must contain only information that is _vital_ to setup and operation on FreeBSD, and that is unique to the port in question.			* [.filename]#pkg-message# must contain only information that is _vital_ to setup and operation on FreeBSD, and that is unique to the port in question.
	* Setup information should only be shown on initial install. Upgrade instructions should be shown only when upgrading from the relevant version.			* Setup information should only be shown on initial install. Upgrade instructions should be shown only when upgrading from the relevant version.
	* Do not surround the messages with either whitespace or lines of symbols (like `----------`, `**********`, or `==========`). Leave the formatting to man:pkg[8].			* Do not surround the messages with either whitespace or lines of symbols (like `----------`, `**********`, or `==========`). Leave the formatting to man:pkg[8].
	* Committers have blanket approval to constrain existing messages to install or upgrade ranges using the UCL format specifications.			* Committers have blanket approval to constrain existing messages to install or upgrade ranges using the UCL format specifications.

	====			====

				[NOTE]
				====
				Please be sure to refer to the proper tools for handling services.
				emasteAuthorUnsubmitted Done Inline Actions I think we avoid (or at least, have avoided) "you" in our documentation. So e.g. "Please be sure to refer..." I've asked in the #bsddocs channel and am looking for a canonical reference. emaste: I think we avoid (or at least, have avoided) "you" in our documentation. So e.g. "Please be…
				emasteAuthorUnsubmitted Done Inline Actions Ah yes, https://docs.freebsd.org/en/books/fdp-primer/writing-style/ Write in a formal style. Avoid addressing the reader as "you". For example, say "copy the file to /tmp" rather than "you can copy the file to /tmp". emaste: Ah yes, https://docs.freebsd.org/en/books/fdp-primer/writing-style/ > Write in a formal style.
				* Use `service name start` to start a service rather than using `/usr/local/etc/rc.d/name start`
				* Use `sysrc name_enable=YES` to change options in rc.conf

				====


	pkg-message supports two formats:			pkg-message supports two formats:

	raw::			raw::
	A regular plain text file.			A regular plain text file.
	Its message is only displayed on install.			Its message is only displayed on install.

	UCL::			UCL::
	If the file starts with "`[`" then it is considered to be a UCL file.			If the file starts with "`[`" then it is considered to be a UCL file.
	▲ Show 20 Lines • Show All 280 Lines • Show Last 20 Lines