From 56fb7960306b77b8eda5f5b0428da2c3702547e3 Mon Sep 17 00:00:00 2001
From: Mathieu Arnold <mat@FreeBSD.org>
Date: Mon, 13 Aug 2018 11:40:30 +0000
Subject: [PATCH] Add a warning about the order of plist helpers/keywords.
Submitted by: dbaio
Sponsored by: Absolight
Differential Revision: https://reviews.freebsd.org/D16598
---
.../books/porters-handbook/plist/chapter.xml | 12 ++++++++++++
1 file changed, 12 insertions(+)
diff --git a/en_US.ISO8859-1/books/porters-handbook/plist/chapter.xml b/en_US.ISO8859-1/books/porters-handbook/plist/chapter.xml
index 461fd5d4e5..6fc072a897 100644
--- a/en_US.ISO8859-1/books/porters-handbook/plist/chapter.xml
+++ b/en_US.ISO8859-1/books/porters-handbook/plist/chapter.xml
@@ -382,6 +382,18 @@ PLIST_SUB= PERL_ARCH=mach</programlisting>
<programlisting>@sample(,games,660) etc/config.sample</programlisting>
+ <warning>
+ <para>If a keyword is used on an <link
+ linkend="makefile-options">optional</link> entry, it must to
+ be added after the helper:</para>
+
+ <programlisting>%%FOO%%@sample etc/orbit.conf.sample</programlisting>
+
+ <para>This is because the options plist helpers are used to
+ comment out the line, so they need to be put first. See <xref
+ linkend="options_sub"/> for more information.</para>
+ </warning>
+
<!--
Keywords up-to-date with r381632.
Try and keep the keywords alphanumerically sorted.