svn commit: r52123 - head/en_US.ISO8859-1/books/porters-handbook/plist

[Mathieu Arnold]

Author: mat
Date: Mon Aug 13 11:40:30 2018
New Revision: 52123
URL: https://svnweb.freebsd.org/changeset/doc/52123

Log:
  Add a warning about the order of plist helpers/keywords.
  
  Submitted by:	dbaio
  Sponsored by:	Absolight
  Differential Revision:	https://reviews.freebsd.org/D16598

Modified:
  head/en_US.ISO8859-1/books/porters-handbook/plist/chapter.xml

Modified: head/en_US.ISO8859-1/books/porters-handbook/plist/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/porters-handbook/plist/chapter.xml	Mon Aug 13 06:24:35 2018	(r52122)
+++ head/en_US.ISO8859-1/books/porters-handbook/plist/chapter.xml	Mon Aug 13 11:40:30 2018	(r52123)
@@ -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.