Improve documentation for --find-package mode

Alex
This commit is contained in:
Alex Neundorf 2011-08-10 02:05:33 +02:00
parent bf07375264
commit d3ae0fff7d
2 changed files with 13 additions and 7 deletions

View File

@ -1,7 +1,11 @@
# COMPILER_ID = GNU/Intel/Clang/MSVC, etc.
# LANGUAGE = C/CXX/Fortan/ASM
# MODE = EXIST/COMPILE/LINK
# 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
#=============================================================================
@ -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)

View File

@ -104,7 +104,9 @@ static const char * cmDocumentationOptions[][3] =
"before the -P argument."},
{"--find-package", "Run in pkg-config like mode.",
"Search a package using find_package() and print the resulting flags "
"to stdout. "},
"to stdout. This can be used to use cmake instead of pkg-config to find "
"installed libraries in plain Makefile-based projects or in "
"autoconf-based projects (via share/aclocal/cmake.m4)."},
{"--graphviz=[file]", "Generate graphviz of dependencies.",
"Generate a graphviz input file that will contain all the library and "
"executable dependencies in the project."},