os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Add documentation for the new CMAKE_ON and CMAKE_OFF variables.

Browse source 
Sponsored by:	Absolight
This commit is contained in:
Mathieu Arnold 2018-01-02 13:47:48 +00:00
parent 0d22a86f1b
commit fcc5fe8db2
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=51361
1 changed files with 40 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
en_US.ISO8859-1/books/porters-handbook/special/chapter.xml
View file

@ -655,6 +655,22 @@ IGNORE= may not be redistributed because of licensing reasons. Please visit <rep
binary.</entry>
</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>
@ -760,6 +776,30 @@ IGNORE= may not be redistributed because of licensing reasons. Please visit <rep
<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>
<sect2 xml:id="using-scons">