From owner-svn-doc-all@freebsd.org  Mon Aug 13 11:40:31 2018
Return-Path: <owner-svn-doc-all@freebsd.org>
Delivered-To: svn-doc-all@mailman.ysv.freebsd.org
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1])
 by mailman.ysv.freebsd.org (Postfix) with ESMTP id 52931106FA1B;
 Mon, 13 Aug 2018 11:40:31 +0000 (UTC) (envelope-from mat@FreeBSD.org)
Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org
 [IPv6:2610:1c1:1:606c::19:3])
 (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
 (Client CN "mxrelay.nyi.freebsd.org",
 Issuer "Let's Encrypt Authority X3" (verified OK))
 by mx1.freebsd.org (Postfix) with ESMTPS id F19347581D;
 Mon, 13 Aug 2018 11:40:30 +0000 (UTC) (envelope-from mat@FreeBSD.org)
Received: from repo.freebsd.org (repo.freebsd.org
 [IPv6:2610:1c1:1:6068::e6a:0])
 (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
 (Client did not present a certificate)
 by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id C85DA43C8;
 Mon, 13 Aug 2018 11:40:30 +0000 (UTC) (envelope-from mat@FreeBSD.org)
Received: from repo.freebsd.org ([127.0.1.37])
 by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id w7DBeU4r056861;
 Mon, 13 Aug 2018 11:40:30 GMT (envelope-from mat@FreeBSD.org)
Received: (from mat@localhost)
 by repo.freebsd.org (8.15.2/8.15.2/Submit) id w7DBeUQj056860;
 Mon, 13 Aug 2018 11:40:30 GMT (envelope-from mat@FreeBSD.org)
Message-Id: <201808131140.w7DBeUQj056860@repo.freebsd.org>
X-Authentication-Warning: repo.freebsd.org: mat set sender to mat@FreeBSD.org
 using -f
From: Mathieu Arnold <mat@FreeBSD.org>
Date: Mon, 13 Aug 2018 11:40:30 +0000 (UTC)
To: doc-committers@freebsd.org, svn-doc-all@freebsd.org,
 svn-doc-head@freebsd.org
Subject: svn commit: r52123 - head/en_US.ISO8859-1/books/porters-handbook/plist
X-SVN-Group: doc-head
X-SVN-Commit-Author: mat
X-SVN-Commit-Paths: head/en_US.ISO8859-1/books/porters-handbook/plist
X-SVN-Commit-Revision: 52123
X-SVN-Commit-Repository: doc
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
X-BeenThere: svn-doc-all@freebsd.org
X-Mailman-Version: 2.1.27
Precedence: list
List-Id: "SVN commit messages for the entire doc trees \(except for &quot;
 user&quot; , &quot; projects&quot; , and &quot; translations&quot;
 \)" <svn-doc-all.freebsd.org>
List-Unsubscribe: <https://lists.freebsd.org/mailman/options/svn-doc-all>,
 <mailto:svn-doc-all-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/svn-doc-all/>
List-Post: <mailto:svn-doc-all@freebsd.org>
List-Help: <mailto:svn-doc-all-request@freebsd.org?subject=help>
List-Subscribe: <https://lists.freebsd.org/mailman/listinfo/svn-doc-all>,
 <mailto:svn-doc-all-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Mon, 13 Aug 2018 11:40:31 -0000

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.