From owner-svn-doc-all@freebsd.org  Tue Jan  2 13:47:50 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:2001:1900:2254:206a::19:1])
 by mailman.ysv.freebsd.org (Postfix) with ESMTP id 2092CEA65E9;
 Tue,  2 Jan 2018 13:47:50 +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 DD05A7F827;
 Tue,  2 Jan 2018 13:47:49 +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 w02Dlm0V069014;
 Tue, 2 Jan 2018 13:47:48 GMT (envelope-from mat@FreeBSD.org)
Received: (from mat@localhost)
 by repo.freebsd.org (8.15.2/8.15.2/Submit) id w02Dlmxq069013;
 Tue, 2 Jan 2018 13:47:48 GMT (envelope-from mat@FreeBSD.org)
Message-Id: <201801021347.w02Dlmxq069013@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: Tue, 2 Jan 2018 13:47:48 +0000 (UTC)
To: doc-committers@freebsd.org, svn-doc-all@freebsd.org,
 svn-doc-head@freebsd.org
Subject: svn commit: r51361 -
 head/en_US.ISO8859-1/books/porters-handbook/special
X-SVN-Group: doc-head
X-SVN-Commit-Author: mat
X-SVN-Commit-Paths: head/en_US.ISO8859-1/books/porters-handbook/special
X-SVN-Commit-Revision: 51361
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.25
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: Tue, 02 Jan 2018 13:47:50 -0000

Author: mat
Date: Tue Jan  2 13:47:48 2018
New Revision: 51361
URL: https://svnweb.freebsd.org/changeset/doc/51361

Log:
  Add documentation for the new CMAKE_ON and CMAKE_OFF variables.
  
  Sponsored by:	Absolight

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

Modified: head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml	Tue Jan  2 11:55:24 2018	(r51360)
+++ head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml	Tue Jan  2 13:47:48 2018	(r51361)
@@ -656,6 +656,22 @@ IGNORE=	may not be redistributed because of licensing 
 	    </row>
 
 	    <row>
+	      <entry><varname>CMAKE_ON</varname></entry>
+	      <entry>For each entry in <varname>CMAKE_ON</varname>, an
+		enabled boolean value is added to
+		<varname>CMAKE_ARGS</varname>.  See <xref
+		  linkend="using-cmake-example2"/>.</entry>
+	    </row>
+
+	    <row>
+	      <entry><varname>CMAKE_OFF</varname></entry>
+	      <entry>For each entry in <varname>CMAKE_OFF</varname>, a
+		disabled boolean value is added to
+		<varname>CMAKE_ARGS</varname>.  See <xref
+		  linkend="using-cmake-example2"/>.</entry>
+	    </row>
+
+	    <row>
 	      <entry><varname>CMAKE_BUILD_TYPE</varname></entry>
 	      <entry>Type of build (<application>CMake</application>
 		predefined build profiles).  Default is
@@ -759,6 +775,30 @@ IGNORE=	may not be redistributed because of licensing 
 
 	<programlisting>USES=			cmake:outsource
 CMAKE_SOURCE_PATH=	&dollar;{WRKSRC}/subproject</programlisting>
+      </example>
+
+      <example xml:id="using-cmake-example2">
+	<title><varname>CMAKE_ON</varname> and
+	  <varname>CMAKE_OFF</varname></title>
+
+	<para>When adding boolean values to
+	  <varname>CMAKE_ARGS</varname>, it is easier to use the
+	  <varname>CMAKE_ON</varname> and <varname>CMAKE_OFF</varname>
+	  variables instead.  This:</para>
+
+	<programlisting>CMAKE_ON=	VAR1 VAR2
+CMAKE_OFF=	VAR3</programlisting>
+
+	<para>Is equivalent to:</para>
+
+	<programlisting>CMAKE_ARGS=	-DVAR1:BOOL=TRUE -DVAR2:BOOL=TRUE -DVAR3:BOOL=FALSE</programlisting>
+
+	<important>
+	  <para>This is only for the default values off
+	    <varname>CMAKE_ARGS</varname>.  The helpers described in
+	    <xref linkend="options-cmake_bool"/> use the same
+	    semantics, but for optional values.</para>
+	</important>
       </example>
     </sect2>