Add extra documentation to VTKmConfig.cmake

Add a note about the VTKm_COMPILE_OPTIONS. Also make an easy to read
list of available components.
This commit is contained in:
Kenneth Moreland 2016-06-29 13:19:42 -06:00
parent 1f0b37fc03
commit d10f40dbaa
2 changed files with 15 additions and 2 deletions

@ -18,11 +18,20 @@
## this software.
##============================================================================
# When this file is run by CMake (usually through the find_package command),
# The following variables will be defined:
# When this file is run by CMake through the find_package command, the
# following variables will be defined:
#
# VTKm_INCLUDE_DIRS - Directories containing VTK-m and dependent headers
# VTKm_LIBRARIES - The libraries required when using VTK-m
# VTKm_COMPILE_OPTIONS - Options VTK-m suggests to add to the compiler
#
# Note that the VTK-m package supports several components. It is important
# to request the components being used (as done through find_package arguments).
# If no components are requested, then the dependent packages will not be
# found and loaded. The following components are supported:
#
# @VTKm_AVAILABLE_COMPONENTS_LIST@
#
@PACKAGE_INIT@

@ -235,6 +235,10 @@ endif(VTKm_BUILD_EXAMPLES)
# Ready files for find_package
include(CMakePackageConfigHelpers)
string(REPLACE ";" " " VTKm_AVAILABLE_COMPONENTS_LIST
"${VTKm_AVAILABLE_COMPONENTS}"
)
set(VTKm_LOAD_COMPONENTS_COMMANDS "
foreach(comp \${VTKm_FIND_COMPONENTS})")