diff options
author | Joachim Wuttke (h) <j.wuttke@fz-juelich.de> | 2018-11-04 14:40:58 (GMT) |
---|---|---|
committer | Joachim Wuttke (o) <j.wuttke@fz-juelich.de> | 2018-11-06 11:55:23 (GMT) |
commit | 9891adf74becfa95463f6928fda9f8ac17c934bd (patch) | |
tree | d551cb0d7d842a2e0ae40ef060fa034c55c8a991 /Help | |
parent | 20b6561e78f5acceecae7c6fc330f7f7de4f2223 (diff) | |
download | CMake-9891adf74becfa95463f6928fda9f8ac17c934bd.zip CMake-9891adf74becfa95463f6928fda9f8ac17c934bd.tar.gz CMake-9891adf74becfa95463f6928fda9f8ac17c934bd.tar.bz2 |
Help: Cross-link conditional and boolean expressions.
Rename Logical -> Boolean Generator Expressions.
It's the return type that helps us to sort the expression zoo.
Diffstat (limited to 'Help')
-rw-r--r-- | Help/manual/cmake-generator-expressions.7.rst | 42 |
1 files changed, 24 insertions, 18 deletions
diff --git a/Help/manual/cmake-generator-expressions.7.rst b/Help/manual/cmake-generator-expressions.7.rst index 094bfc1..1c3d3fc 100644 --- a/Help/manual/cmake-generator-expressions.7.rst +++ b/Help/manual/cmake-generator-expressions.7.rst @@ -25,11 +25,13 @@ conditional include directories, and more. The conditions may be based on the build configuration, target properties, platform information or any other queryable information. -Conditional Expressions -======================= +.. _`Conditional Generator Expressions`: -Conditional expressions depend on a boolean condition that must be -``0`` or ``1``. +Conditional Generator Expressions +================================= + +Conditional generator expressions depend on a boolean condition +that must be ``0`` or ``1``. ``$<condition:true_value>`` Evaluates to ``true_value`` if ``condition`` is ``1``. @@ -39,23 +41,27 @@ Conditional expressions depend on a boolean condition that must be Evaluates to ``true_value`` if ``condition`` is ``1``. Otherwise evaluates to ``false_value``. - -Logical Expressions -=================== - -Logical expressions are used to create conditional output. The basic -expressions are the ``0`` and ``1`` expressions. Because other logical -expressions evaluate to either ``0`` or ``1``, they can be composed to -create conditional output: +Typically, the ``condition`` is a +:ref:`boolean generator expression<Boolean Generator Expressions>`. +For instance, .. code-block:: cmake $<$<CONFIG:Debug>:DEBUG_MODE> expands to ``DEBUG_MODE`` when the ``Debug`` configuration is used, and -otherwise expands to nothing. +otherwise expands to the empty string. + +.. _`Boolean Generator Expressions`: + +Boolean Generator Expressions +============================= + +Boolean expressions evaluate to either ``0`` or ``1``. +They are typically used to construct the condition in a +:ref:`conditional generator expression<Conditional Generator Expressions>`. -Available logical expressions are: +Available boolean expressions are: ``$<BOOL:condition>`` ``1`` if the ``condition`` is true, else ``0`` @@ -171,8 +177,8 @@ Available logical expressions are: add_executable(myapp main.cpp) target_link_libraries(myapp myapp_c myapp_cxx) -Informational Expressions -========================= +Informational Generator Expressions +=================================== These expressions expand to some information. The information may be used directly, eg: @@ -272,8 +278,8 @@ Available informational expressions are: the unary version for notes about portability of this generator expression. -Output Expressions -================== +Output Generator Expressions +============================ These expressions generate output, in some cases depending on an input. These expressions may be combined with other expressions for information or logical |