summaryrefslogtreecommitdiffstats
path: root/Help/command
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2019-11-08 14:14:31 (GMT)
committerBrad King <brad.king@kitware.com>2019-11-08 14:49:26 (GMT)
commitf35df783b5c26b5ad1e54719ef1dac062c532bd7 (patch)
tree9613528d38d8949b7a27b55711db062487254362 /Help/command
parentc1d5d5eb11e0260ffadda0851ac844ab46b6b179 (diff)
downloadCMake-f35df783b5c26b5ad1e54719ef1dac062c532bd7.zip
CMake-f35df783b5c26b5ad1e54719ef1dac062c532bd7.tar.gz
CMake-f35df783b5c26b5ad1e54719ef1dac062c532bd7.tar.bz2
Help: Document target_precompile_headers genex with angle brackets
When passing a `<header>` inside a generator expression, the closing `>` needs to be encoded as `$<ANGLE-R>`. Add an example to the docs. Fixes: #19940
Diffstat (limited to 'Help/command')
-rw-r--r--Help/command/target_precompile_headers.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/Help/command/target_precompile_headers.rst b/Help/command/target_precompile_headers.rst
index d283948..5ab3766 100644
--- a/Help/command/target_precompile_headers.rst
+++ b/Help/command/target_precompile_headers.rst
@@ -79,6 +79,17 @@ must be available for the compiler to find them. Other header file names
source directory (e.g. :variable:`CMAKE_CURRENT_SOURCE_DIR`) and will be
included by absolute path.
+When specifying angle brackets inside a :manual:`generator expression
+<cmake-generator-expressions(7)>`, be sure to encode the closing ``>``
+as ``$<ANGLE-R>``. For example:
+
+.. code-block:: cmake
+
+ target_precompile_headers(mylib PRIVATE
+ "$<$<COMPILE_LANGUAGE:C>:<stddef.h$<ANGLE-R>>"
+ "$<$<COMPILE_LANGUAGE:CXX>:<cstddef$<ANGLE-R>>"
+ )
+
See Also
^^^^^^^^