diff options
| author | Kitware Robot <kwrobot@kitware.com> | 2013-10-15 11:17:36 -0400 |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2013-10-15 14:12:03 -0400 |
| commit | f051814ed0e63badbfd68049354f36259dbf4b49 (patch) | |
| tree | f4e6f885f86c882d723a7dd53d2b702d0c7fdffb /Modules/CMakePrintHelpers.cmake | |
| parent | e94958e99c4dec26c86ce8b76d744c04ba960675 (diff) | |
| download | cmake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.gz | |
Convert builtin help to reStructuredText source files
Run the convert-help.bash script to convert documentation:
./convert-help.bash "/path/to/CMake-build/bin"
Then remove it.
Diffstat (limited to 'Modules/CMakePrintHelpers.cmake')
| -rw-r--r-- | Modules/CMakePrintHelpers.cmake | 55 |
1 files changed, 39 insertions, 16 deletions
diff --git a/Modules/CMakePrintHelpers.cmake b/Modules/CMakePrintHelpers.cmake index ef5d857b63..72832ada6f 100644 --- a/Modules/CMakePrintHelpers.cmake +++ b/Modules/CMakePrintHelpers.cmake @@ -1,29 +1,52 @@ -# - Convenience macros for printing properties and variables, useful e.g. for debugging. +#.rst: +# CMakePrintHelpers +# ----------------- +# +# Convenience macros for printing properties and variables, useful e.g. for debugging. +# +# +# +# +# +# CMAKE_PRINT_PROPERTIES([TARGETS target1 .. targetN] +# +# :: +# +# [SOURCES source1 .. sourceN] +# [DIRECTORIES dir1 .. dirN] +# [TESTS test1 .. testN] +# [CACHE_ENTRIES entry1 .. entryN] +# PROPERTIES prop1 .. propN ) # # -# CMAKE_PRINT_PROPERTIES([TARGETS target1 .. targetN] -# [SOURCES source1 .. sourceN] -# [DIRECTORIES dir1 .. dirN] -# [TESTS test1 .. testN] -# [CACHE_ENTRIES entry1 .. entryN] -# PROPERTIES prop1 .. propN ) # # This macro prints the values of the properties of the given targets, -# source files, directories, tests or cache entries. Exactly one of the -# scope keywords must be used. -# Example: -# cmake_print_properties(TARGETS foo bar PROPERTIES LOCATION INTERFACE_INCLUDE_DIRS) -# This will print the LOCATION and INTERFACE_INCLUDE_DIRS properties for both -# targets foo and bar. +# source files, directories, tests or cache entries. Exactly one of the +# scope keywords must be used. Example: # +# :: # -# CMAKE_PRINT_VARIABLES(var1 var2 .. varN) +# cmake_print_properties(TARGETS foo bar PROPERTIES LOCATION INTERFACE_INCLUDE_DIRS) +# +# This will print the LOCATION and INTERFACE_INCLUDE_DIRS properties for +# both targets foo and bar. +# +# +# +# CMAKE_PRINT_VARIABLES(var1 var2 .. varN) # # This macro will print the name of each variable followed by its value. # Example: -# cmake_print_variables(CMAKE_C_COMPILER CMAKE_MAJOR_VERSION THIS_ONE_DOES_NOT_EXIST) +# +# :: +# +# cmake_print_variables(CMAKE_C_COMPILER CMAKE_MAJOR_VERSION THIS_ONE_DOES_NOT_EXIST) +# # Gives: -# -- CMAKE_C_COMPILER="/usr/bin/gcc" ; CMAKE_MAJOR_VERSION="2" ; THIS_ONE_DOES_NOT_EXIST="" +# +# :: +# +# -- CMAKE_C_COMPILER="/usr/bin/gcc" ; CMAKE_MAJOR_VERSION="2" ; THIS_ONE_DOES_NOT_EXIST="" #============================================================================= # Copyright 2013 Alexander Neundorf, <neundorf@kde.org> |