svn commit: r51361 - head/en_US.ISO8859-1/books/porters-handbook/special

[Mathieu Arnold]

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=	${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>