Merge topic 'CMakePrintHelpers'

1c94129e98 Help: correct macro -> function in CMakePrintHelpers

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !2596
This commit is contained in:
Brad King
2018-11-12 21:27:52 +00:00
committed by Kitware Robot

View File

@@ -5,32 +5,33 @@
CMakePrintHelpers
-----------------
Convenience macros for printing properties and variables, useful e.g. for debugging.
Convenience functions for printing properties and variables, useful
e.g. for debugging.
::
CMAKE_PRINT_PROPERTIES([TARGETS target1 .. targetN]
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,
This function 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)
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)
CMAKE_PRINT_VARIABLES(var1 var2 .. varN)
This macro will print the name of each variable followed by its value.
This function will print the name of each variable followed by its value.
Example::
cmake_print_variables(CMAKE_C_COMPILER CMAKE_MAJOR_VERSION DOES_NOT_EXIST)
@@ -40,7 +41,7 @@ Gives::
-- CMAKE_C_COMPILER="/usr/bin/gcc" ; CMAKE_MAJOR_VERSION="2" ; DOES_NOT_EXIST=""
#]=======================================================================]
function(CMAKE_PRINT_VARIABLES)
function(cmake_print_variables)
set(msg "")
foreach(var ${ARGN})
if(msg)
@@ -52,7 +53,7 @@ function(CMAKE_PRINT_VARIABLES)
endfunction()
function(CMAKE_PRINT_PROPERTIES )
function(cmake_print_properties)
set(options )
set(oneValueArgs )
set(multiValueArgs TARGETS SOURCES TESTS DIRECTORIES CACHE_ENTRIES PROPERTIES )