From owner-svn-doc-head@freebsd.org  Mon Sep  4 12:10:25 2017
Return-Path: <owner-svn-doc-head@freebsd.org>
Delivered-To: svn-doc-head@mailman.ysv.freebsd.org
Received: from mx1.freebsd.org (mx1.freebsd.org
 [IPv6:2001:1900:2254:206a::19:1])
 by mailman.ysv.freebsd.org (Postfix) with ESMTP id F3B08E03CE8;
 Mon,  4 Sep 2017 12:10:24 +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 mx1.freebsd.org (Postfix) with ESMTPS id C0833714B2;
 Mon,  4 Sep 2017 12:10:24 +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 v84CANfk052786;
 Mon, 4 Sep 2017 12:10:23 GMT (envelope-from mat@FreeBSD.org)
Received: (from mat@localhost)
 by repo.freebsd.org (8.15.2/8.15.2/Submit) id v84CANaj052785;
 Mon, 4 Sep 2017 12:10:23 GMT (envelope-from mat@FreeBSD.org)
Message-Id: <201709041210.v84CANaj052785@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, 4 Sep 2017 12:10:23 +0000 (UTC)
To: doc-committers@freebsd.org, svn-doc-all@freebsd.org,
 svn-doc-head@freebsd.org
Subject: svn commit: r50800 -
 head/en_US.ISO8859-1/books/porters-handbook/slow-porting
X-SVN-Group: doc-head
X-SVN-Commit-Author: mat
X-SVN-Commit-Paths: head/en_US.ISO8859-1/books/porters-handbook/slow-porting
X-SVN-Commit-Revision: 50800
X-SVN-Commit-Repository: doc
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
X-BeenThere: svn-doc-head@freebsd.org
X-Mailman-Version: 2.1.23
Precedence: list
List-Id: SVN commit messages for the doc tree for head
 <svn-doc-head.freebsd.org>
List-Unsubscribe: <https://lists.freebsd.org/mailman/options/svn-doc-head>,
 <mailto:svn-doc-head-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/svn-doc-head/>
List-Post: <mailto:svn-doc-head@freebsd.org>
List-Help: <mailto:svn-doc-head-request@freebsd.org?subject=help>
List-Subscribe: <https://lists.freebsd.org/mailman/listinfo/svn-doc-head>,
 <mailto:svn-doc-head-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Mon, 04 Sep 2017 12:10:25 -0000

Author: mat
Date: Mon Sep  4 12:10:23 2017
New Revision: 50800
URL: https://svnweb.freebsd.org/changeset/doc/50800

Log:
  Add a section about conditional patching with EXTRA_PATCHES.
  
  Reviewed by:	wblock
  Sponsored by:	Absolight
  Differential Revision:	https://reviews.freebsd.org/D12165

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

Modified: head/en_US.ISO8859-1/books/porters-handbook/slow-porting/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/porters-handbook/slow-porting/chapter.xml	Mon Sep  4 09:29:51 2017	(r50799)
+++ head/en_US.ISO8859-1/books/porters-handbook/slow-porting/chapter.xml	Mon Sep  4 12:10:23 2017	(r50800)
@@ -450,6 +450,50 @@ DOS2UNIX_GLOB=	*.c *.cpp *.h</programlisting>
       <programlisting>USES=	dos2unix
 DOS2UNIX_WRKSRC=	${WRKDIR}</programlisting>
     </sect2>
+
+    <sect2 xml:id="slow-patch-extra">
+      <title>Patching Conditionally</title>
+
+      <para>Some ports need patches that are only applied for specific
+	&os; versions or when a particular option is enabled or
+	disabled.  Conditional patches are specified by placing the
+	full paths to the patch files in
+	<varname>EXTRA_PATCHES</varname>.</para>
+
+      <example xml:id="slow-patch-extra-ex1">
+	<title>Applying a Patch for a Specific &os; Version</title>
+
+	<programlisting>.include &lt;bsd.port.options.mk&gt;
+
+# Patch in the iconv const qualifier before this
+.if ${OPSYS} == FreeBSD &amp;&amp; ${OSVERSION} &lt; 1100069
+EXTRA_PATCHES=	${PATCHDIR}/extra-patch-fbsd10
+.endif
+
+.include &lt;bsd.port.mk&gt;</programlisting>
+
+      </example>
+
+      <example xml:id="slow-patch-extra-ex2">
+	<title>Optionaly Applying a Patch</title>
+
+	<para>When an <link linkend="makefile-options">option</link>
+	  requires a patch, use
+	  <varname><replaceable>opt</replaceable>_EXTRA_PATCHES</varname>
+	  and
+	  <varname><replaceable>opt</replaceable>_EXTRA_PATCHES_OFF</varname>
+	  to make the patch conditional on the
+	  <literal><replaceable>opt</replaceable></literal> option.
+	  See <xref linkend="options-variables"/> for more
+	  information.</para>
+
+	<programlisting>OPTIONS_DEFINE=	  FOO BAR
+FOO_EXTRA_PATCHES=  ${PATCHDIR}/extra-patch-foo
+BAR_EXTRA_PATCHES_OFF=	${PATCHDIR}/extra-patch-bar.c \
+		${PATCHDIR}/extra-patch-bar.h</programlisting>
+      </example>
+
+    </sect2>
   </sect1>
 
   <sect1 xml:id="slow-configure">