summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorJoachim Wuttke (h) <j.wuttke@fz-juelich.de>2018-11-04 22:00:12 (GMT)
committerJoachim Wuttke (o) <j.wuttke@fz-juelich.de>2018-11-06 11:55:24 (GMT)
commite0f0f80f0286b7181b1203693799f5fcfcd8b4af (patch)
tree72ac0195239af85610ce85591f32a0e4ff12828f /Help
parent2b2b41f038af97b7bca2213cda0198d2a28f6c2e (diff)
downloadCMake-e0f0f80f0286b7181b1203693799f5fcfcd8b4af.zip
CMake-e0f0f80f0286b7181b1203693799f5fcfcd8b4af.tar.gz
CMake-e0f0f80f0286b7181b1203693799f5fcfcd8b4af.tar.bz2
Help: Explain conversion rules of $<BOOL:string>.
This resolves #18549.
Diffstat (limited to 'Help')
-rw-r--r--Help/manual/cmake-generator-expressions.7.rst12
1 files changed, 10 insertions, 2 deletions
diff --git a/Help/manual/cmake-generator-expressions.7.rst b/Help/manual/cmake-generator-expressions.7.rst
index c5d7a31..eb9c9fe 100644
--- a/Help/manual/cmake-generator-expressions.7.rst
+++ b/Help/manual/cmake-generator-expressions.7.rst
@@ -44,8 +44,16 @@ Available boolean expressions are:
Logical Operators
-----------------
-``$<BOOL:condition>``
- ``1`` if the ``condition`` is true, else ``0``
+``$<BOOL:string>``
+ Converts ``string`` to ``0`` or ``1`` according to the rules of the
+ :command:`if()` command. Evaluates to ``0`` if any of the following is true:
+
+ * ``string`` is empty,
+ * ``string`` is a case-insensitive equal of
+ ``0``, ``FALSE``, ``OFF``, ``N``, ``NO``, ``IGNORE``, or ``NOTFOUND``, or
+ * ``string`` ends in the suffix ``-NOTFOUND`` (case-sensitive).
+
+ Otherwise evaluates to ``1``.
``$<AND:conditions>``
where ``conditions`` is a comma-separated list of boolean expressions.