diff options
| author | Alex Neundorf <neundorf@kde.org> | 2013-02-21 21:49:29 +0100 |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2013-02-22 08:32:34 -0500 |
| commit | c1f5780e2d25015ba22dd0a7c8d43c925a62a7f6 (patch) | |
| tree | 4be53d8418245fb0faac5b92ecaf6b1a27d24c2b /Modules/FindPackageHandleStandardArgs.cmake | |
| parent | 7bb1abe56a05ccc50ff2c56e2df60f305af17ca4 (diff) | |
| download | cmake-c1f5780e2d25015ba22dd0a7c8d43c925a62a7f6.tar.gz | |
FPHSA: improve documentation
Alex
Diffstat (limited to 'Modules/FindPackageHandleStandardArgs.cmake')
| -rw-r--r-- | Modules/FindPackageHandleStandardArgs.cmake | 20 |
1 files changed, 12 insertions, 8 deletions
diff --git a/Modules/FindPackageHandleStandardArgs.cmake b/Modules/FindPackageHandleStandardArgs.cmake index ce89c059ff..5f92a8642a 100644 --- a/Modules/FindPackageHandleStandardArgs.cmake +++ b/Modules/FindPackageHandleStandardArgs.cmake @@ -30,6 +30,7 @@ # Other names for the result-variable are not allowed. # So for a Find-module named FindFooBar.cmake, the two possible names are # FooBar_FOUND and FOOBAR_FOUND. It is recommended to use the original case version. +# If the FOUND_VAR option is not used, the default is <UPPERCASED_NAME>_FOUND. # # As in the simple mode, if <var1> through <varN> are all valid, # <packagename>_FOUND will be set to TRUE. @@ -54,7 +55,7 @@ # # Example for mode 1: # -# FIND_PACKAGE_HANDLE_STANDARD_ARGS(LibXml2 DEFAULT_MSG LIBXML2_LIBRARY LIBXML2_INCLUDE_DIR) +# find_package_handle_standard_args(LibXml2 DEFAULT_MSG LIBXML2_LIBRARY LIBXML2_INCLUDE_DIR) # # LibXml2 is considered to be found, if both LIBXML2_LIBRARY and # LIBXML2_INCLUDE_DIR are valid. Then also LIBXML2_FOUND is set to TRUE. @@ -65,20 +66,23 @@ # # Example for mode 2: # -# FIND_PACKAGE_HANDLE_STANDARD_ARGS(BISON REQUIRED_VARS BISON_EXECUTABLE -# VERSION_VAR BISON_VERSION) -# In this case, BISON is considered to be found if the variable(s) listed -# after REQUIRED_VAR are all valid, i.e. BISON_EXECUTABLE in this case. -# Also the version of BISON will be checked by using the version contained -# in BISON_VERSION. +# find_package_handle_standard_args(LibXslt FOUND_VAR LibXslt_FOUND +# REQUIRED_VARS LibXslt_LIBRARIES LibXslt_INCLUDE_DIRS +# VERSION_VAR LibXslt_VERSION_STRING) +# In this case, LibXslt is considered to be found if the variable(s) listed +# after REQUIRED_VAR are all valid, i.e. LibXslt_LIBRARIES and LibXslt_INCLUDE_DIRS +# in this case. The result will then be stored in LibXslt_FOUND . +# Also the version of LibXslt will be checked by using the version contained +# in LibXslt_VERSION_STRING. # Since no FAIL_MESSAGE is given, the default messages will be printed. # # Another example for mode 2: # # find_package(Automoc4 QUIET NO_MODULE HINTS /opt/automoc4) -# FIND_PACKAGE_HANDLE_STANDARD_ARGS(Automoc4 CONFIG_MODE) +# find_package_handle_standard_args(Automoc4 CONFIG_MODE) # In this case, FindAutmoc4.cmake wraps a call to find_package(Automoc4 NO_MODULE) # and adds an additional search directory for automoc4. +# Here the result will be stored in AUTOMOC4_FOUND. # The following FIND_PACKAGE_HANDLE_STANDARD_ARGS() call produces a proper # success/error message. |