summaryrefslogtreecommitdiffstats
path: root/Help/manual
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2014-10-22 20:43:05 (GMT)
committerBrad King <brad.king@kitware.com>2014-10-22 20:48:04 (GMT)
commit80b19a7127e48dfc0e8cd0162359ae149e537638 (patch)
treeb164da556a4cbb9d0315f01c6b9fe92de955acc5 /Help/manual
parent4fdacedc27aa26501530fc85f887ab58b2800472 (diff)
downloadCMake-80b19a7127e48dfc0e8cd0162359ae149e537638.zip
CMake-80b19a7127e48dfc0e8cd0162359ae149e537638.tar.gz
CMake-80b19a7127e48dfc0e8cd0162359ae149e537638.tar.bz2
Help/manual: Avoid long lines in code blocks
Update the wording of some examples to avoid long lines in code blocks. Otherwise the formatted documentation can exceed certain column width limitations.
Diffstat (limited to 'Help/manual')
-rw-r--r--Help/manual/cmake-compile-features.7.rst7
-rw-r--r--Help/manual/cmake-developer.7.rst3
-rw-r--r--Help/manual/cmake-generator-expressions.7.rst12
-rw-r--r--Help/manual/cmake-toolchains.7.rst5
4 files changed, 21 insertions, 6 deletions
diff --git a/Help/manual/cmake-compile-features.7.rst b/Help/manual/cmake-compile-features.7.rst
index 8a2fe30..8e3dbb8 100644
--- a/Help/manual/cmake-compile-features.7.rst
+++ b/Help/manual/cmake-compile-features.7.rst
@@ -276,10 +276,13 @@ properties:
.. code-block:: cmake
add_library(foo INTERFACE)
+ set(with_variadics ${CMAKE_CURRENT_SOURCE_DIR}/with_variadics)
+ set(no_variadics ${CMAKE_CURRENT_SOURCE_DIR}/no_variadics)
target_link_libraries(foo
INTERFACE
- "$<$<COMPILE_FEATURES:cxx_variadic_templates>:${CMAKE_CURRENT_SOURCE_DIR}/with_variadics>"
- "$<$<NOT:$<COMPILE_FEATURES:cxx_variadic_templates>>:${CMAKE_CURRENT_SOURCE_DIR}/no_variadics>")
+ "$<$<COMPILE_FEATURES:cxx_variadic_templates>:${with_variadics}>"
+ "$<$<NOT:$<COMPILE_FEATURES:cxx_variadic_templates>>:${no_variadics}>"
+ )
Consuming code then simply links to the ``foo`` target as usual and uses
the feature-appropriate include directory
diff --git a/Help/manual/cmake-developer.7.rst b/Help/manual/cmake-developer.7.rst
index 625dac0..eea5fc3 100644
--- a/Help/manual/cmake-developer.7.rst
+++ b/Help/manual/cmake-developer.7.rst
@@ -1005,7 +1005,8 @@ projects that do not require a high enough CMake version.
.. code-block:: cmake
if(CMAKE_MINIMUM_REQUIRED_VERSION VERSION_LESS 3.0.0)
- message(AUTHOR_WARNING "Your project should require at least CMake 3.0.0 to use FindFoo.cmake")
+ message(AUTHOR_WARNING
+ "Your project should require at least CMake 3.0.0 to use FindFoo.cmake")
endif()
Now the actual libraries and so on have to be found. The code here will
diff --git a/Help/manual/cmake-generator-expressions.7.rst b/Help/manual/cmake-generator-expressions.7.rst
index 77259a0..981bd84 100644
--- a/Help/manual/cmake-generator-expressions.7.rst
+++ b/Help/manual/cmake-generator-expressions.7.rst
@@ -38,6 +38,8 @@ create conditional output::
expands to ``DEBUG_MODE`` when the ``Debug`` configuration is used, and
otherwise expands to nothing.
+Available logical expressions are:
+
``$<0:...>``
Empty string (ignores ``...``)
``$<1:...>``
@@ -111,6 +113,8 @@ expands to ``OLD_COMPILER`` if the
:variable:`CMAKE_CXX_COMPILER_VERSION <CMAKE_<LANG>_COMPILER_VERSION>` is less
than 4.2.0.
+Available informational expressions are:
+
``$<CONFIGURATION>``
Configuration name. Deprecated. Use ``CONFIG`` instead.
``$<CONFIG>``
@@ -185,7 +189,13 @@ property with each entry preceeded by ``-I``. Note that a more-complete use
in this situation would require first checking if the INCLUDE_DIRECTORIES
property is non-empty::
- $<$<BOOL:$<TARGET_PROPERTY:INCLUDE_DIRECTORIES>>:-I$<JOIN:$<TARGET_PROPERTY:INCLUDE_DIRECTORIES>, -I>>
+ $<$<BOOL:${prop}>:-I$<JOIN:${prop}, -I>>
+
+where ``${prop}`` refers to a helper variable::
+
+ set(prop "$<TARGET_PROPERTY:INCLUDE_DIRECTORIES>")
+
+Available output expressions are:
``$<JOIN:list,...>``
Joins the list with the content of ``...``
diff --git a/Help/manual/cmake-toolchains.7.rst b/Help/manual/cmake-toolchains.7.rst
index 1621b5f..fad5481 100644
--- a/Help/manual/cmake-toolchains.7.rst
+++ b/Help/manual/cmake-toolchains.7.rst
@@ -115,8 +115,9 @@ as:
set(CMAKE_SYSROOT /home/devel/rasp-pi-rootfs)
set(CMAKE_STAGING_PREFIX /home/devel/stage)
- set(CMAKE_C_COMPILER /home/devel/gcc-4.7-linaro-rpi-gnueabihf/bin/arm-linux-gnueabihf-gcc)
- set(CMAKE_CXX_COMPILER /home/devel/gcc-4.7-linaro-rpi-gnueabihf/bin/arm-linux-gnueabihf-g++)
+ set(tools /home/devel/gcc-4.7-linaro-rpi-gnueabihf)
+ set(CMAKE_C_COMPILER ${tools}/bin/arm-linux-gnueabihf-gcc)
+ set(CMAKE_CXX_COMPILER ${tools}/bin/arm-linux-gnueabihf-g++)
set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER)
set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY)