summaryrefslogtreecommitdiffstats
path: root/Modules/CMakeFindPackageMode.cmake
diff options
context:
space:
mode:
Diffstat (limited to 'Modules/CMakeFindPackageMode.cmake')
-rw-r--r--Modules/CMakeFindPackageMode.cmake16
1 files changed, 10 insertions, 6 deletions
diff --git a/Modules/CMakeFindPackageMode.cmake b/Modules/CMakeFindPackageMode.cmake
index 3e7376c..2ce4fe6 100644
--- a/Modules/CMakeFindPackageMode.cmake
+++ b/Modules/CMakeFindPackageMode.cmake
@@ -1,8 +1,12 @@
-# COMPILER_ID = GNU/Intel/Clang/MSVC, etc.
-# LANGUAGE = C/CXX/Fortan/ASM
-# MODE = EXIST/COMPILE/LINK
-# NAME = name of the package
-# QUIET = if TRUE, don't print anything
+# This file is executed by cmake when invoked with --find-package.
+# It expects that the following variables are set using -D:
+# NAME = name of the package
+# COMPILER_ID = the CMake compiler ID for which the result is, i.e. GNU/Intel/Clang/MSVC, etc.
+# LANGUAGE = language for which the result will be used, i.e. C/CXX/Fortan/ASM
+# MODE = EXIST : only check for existance of the given package
+# COMPILE : print the flags needed for compiling an object file which uses the given package
+# LINK : print the flags needed for linking when using the given package
+# QUIET = if TRUE, don't print anything
#=============================================================================
# Copyright 2006-2011 Alexander Neundorf, <neundorf@kde.org>
@@ -18,7 +22,7 @@
# License text for the above reference.)
if(NOT NAME)
- message(FATAL_ERROR "NAME argument not specified.")
+ message(FATAL_ERROR "Name of the package to be searched not specified. Set the CMake variable NAME, e.g. -DNAME=JPEG .")
endif()
if(NOT COMPILER_ID)