2009-09-30 13:53:48 +00:00
|
|
|
For more information about how to contribute modules to CMake, see this page:
|
|
|
|
http://www.itk.org/Wiki/CMake:Module_Maintainers
|
|
|
|
|
2013-03-26 17:52:30 +00:00
|
|
|
Note to authors of FindXxx.cmake files
|
2002-09-02 11:03:43 +00:00
|
|
|
|
2013-03-26 17:52:30 +00:00
|
|
|
We would like all FindXxx.cmake files to produce consistent variable names.
|
2002-09-02 11:03:43 +00:00
|
|
|
|
2002-09-06 14:55:55 +00:00
|
|
|
Please use the following consistent variable names for general use.
|
2002-09-02 11:03:43 +00:00
|
|
|
|
2013-03-26 17:57:53 +00:00
|
|
|
Xxx_INCLUDE_DIRS The final set of include directories listed in one variable for use by client code.
|
|
|
|
This should not be a cache entry.
|
|
|
|
Xxx_LIBRARIES The libraries to link against to use Xxx. These should include full paths.
|
|
|
|
This should not be a cache entry.
|
|
|
|
Xxx_DEFINITIONS Definitions to use when compiling code that uses Xxx. This really shouldn't include options such
|
|
|
|
as (-DHAS_JPEG)that a client source-code file uses to decide whether to #include <jpeg.h>
|
2013-03-26 17:52:30 +00:00
|
|
|
Xxx_EXECUTABLE Where to find the Xxx tool.
|
|
|
|
Xxx_Yyy_EXECUTABLE Where to find the Yyy tool that comes with Xxx.
|
2013-03-26 17:57:53 +00:00
|
|
|
Xxx_LIBRARY_DIRS Optionally, the final set of library directories listed in one variable for use by client code.
|
|
|
|
This should not be a cache entry.
|
2013-03-26 17:52:30 +00:00
|
|
|
Xxx_ROOT_DIR Where to find the base directory of Xxx.
|
|
|
|
Xxx_VERSION_Yy Expect Version Yy if true. Make sure at most one of these is ever true.
|
2013-03-26 17:57:53 +00:00
|
|
|
Xxx_WRAP_Yy If False, do not try to use the relevant CMake wrapping command.
|
2013-03-26 17:52:30 +00:00
|
|
|
Xxx_Yy_FOUND If False, optional Yy part of Xxx sytem is not available.
|
|
|
|
Xxx_FOUND Set to false, or undefined, if we haven't found, or don't want to use Xxx.
|
|
|
|
Xxx_NOT_FOUND_MESSAGE Should be set by config-files in the case that it has set Xxx_FOUND to FALSE.
|
2012-09-19 19:50:55 +00:00
|
|
|
The contained message will be printed by the find_package() command and by
|
|
|
|
find_package_handle_standard_args() to inform the user about the problem.
|
2013-03-26 17:57:53 +00:00
|
|
|
Xxx_RUNTIME_LIBRARY_DIRS Optionally, the runtime library search path for use when running an executable linked to
|
|
|
|
shared libraries.
|
2006-11-01 14:06:27 +00:00
|
|
|
The list should be used by user code to create the PATH on windows or LD_LIBRARY_PATH on unix.
|
|
|
|
This should not be a cache entry.
|
2013-03-26 17:52:30 +00:00
|
|
|
Xxx_VERSION_STRING A human-readable string containing the version of the package found, if any.
|
|
|
|
Xxx_VERSION_MAJOR The major version of the package found, if any.
|
|
|
|
Xxx_VERSION_MINOR The minor version of the package found, if any.
|
|
|
|
Xxx_VERSION_PATCH The patch version of the package found, if any.
|
2002-09-02 11:03:43 +00:00
|
|
|
|
2013-03-26 17:57:53 +00:00
|
|
|
You do not have to provide all of the above variables. You should provide Xxx_FOUND under most circumstances.
|
|
|
|
If Xxx is a library, then Xxx_LIBRARIES, should also be defined, and Xxx_INCLUDE_DIRS should usually be
|
|
|
|
defined (I guess libm.a might be an exception)
|
2002-09-02 11:03:43 +00:00
|
|
|
|
2013-03-26 17:57:53 +00:00
|
|
|
The following names should not usually be used in CMakeLists.txt files, but they may be usefully modified in
|
|
|
|
users' CMake Caches to control stuff.
|
2002-09-02 11:03:43 +00:00
|
|
|
|
2013-03-26 17:52:30 +00:00
|
|
|
Xxx_LIBRARY Name of Xxx Library. A User may set this and Xxx_INCLUDE_DIR to ignore to force non-use of Xxx.
|
|
|
|
Xxx_Yy_LIBRARY Name of Yy library that is part of the Xxx system. It may or may not be required to use Xxx.
|
2013-03-26 17:57:53 +00:00
|
|
|
Xxx_INCLUDE_DIR Where to find xxx.h, etc. (Xxx_INCLUDE_PATH was considered bad because a path includes an
|
|
|
|
actual filename.)
|
2013-03-26 17:52:30 +00:00
|
|
|
Xxx_Yy_INCLUDE_DIR Where to find xxx_yy.h, etc.
|
2002-09-06 14:55:55 +00:00
|
|
|
|
2013-03-26 17:57:53 +00:00
|
|
|
For tidiness's sake, try to keep as many options as possible out of the cache, leaving at least one option which can be
|
|
|
|
used to disable use of the module, or locate a not-found library (e.g. Xxx_ROOT_DIR).
|
|
|
|
For the same reason, mark most cache options as advanced.
|
2002-09-06 14:55:55 +00:00
|
|
|
|
2013-03-26 17:57:53 +00:00
|
|
|
If you need other commands to do special things then it should still begin with Xxx_. This gives a sort of namespace
|
|
|
|
effect and keeps things tidy for the user. You should put comments describing all the exported settings, plus
|
|
|
|
descriptions of any the users can use to control stuff.
|
2002-09-06 14:55:55 +00:00
|
|
|
|
2013-03-26 17:57:53 +00:00
|
|
|
You really should also provide backwards compatibility any old settings that were actually in use.
|
|
|
|
Make sure you comment them as deprecated, so that no-one starts using them.
|
2005-12-14 18:51:08 +00:00
|
|
|
|
2013-03-26 17:57:53 +00:00
|
|
|
To correctly document a module, create a comment block at the top with # comments.
|
|
|
|
There are three types of comments that can be in the block:
|
2005-12-14 18:51:08 +00:00
|
|
|
|
|
|
|
1. The brief description of the module, this is done by:
|
|
|
|
# - a small description
|
|
|
|
|
|
|
|
2. A paragraph of text. This is done with all text that has a single
|
|
|
|
space between the # and the text. To create a new paragraph, just
|
|
|
|
put a # with no text on the line.
|
|
|
|
|
|
|
|
3. A verbatim line. This is done with two spaces between the # and the text.
|
|
|
|
|
|
|
|
For example:
|
|
|
|
|
|
|
|
# - This is a cool module
|
|
|
|
# This module does really cool stuff.
|
|
|
|
# It can do even more than you think.
|
2012-03-18 16:26:24 +00:00
|
|
|
#
|
2005-12-14 18:51:08 +00:00
|
|
|
# It even needs to paragraphs to tell you about it.
|
|
|
|
# And it defines the following variables:
|
2007-07-19 13:00:51 +00:00
|
|
|
# VAR_COOL - this is great isn't it?
|
2005-12-14 18:51:08 +00:00
|
|
|
# VAR_REALLY_COOL - cool right?
|
|
|
|
#
|
|
|
|
|
2013-03-26 17:52:30 +00:00
|
|
|
Test the documentation formatting by running "cmake --help-module FindXxx".
|
2011-04-01 17:46:36 +00:00
|
|
|
Edit the comments until the output of this command looks satisfactory.
|
|
|
|
|
2005-12-14 18:51:08 +00:00
|
|
|
To have a .cmake file in this directory NOT show up in the
|
|
|
|
modules documentation, you should start the file with a blank
|
|
|
|
line.
|
|
|
|
|
2011-04-01 17:46:36 +00:00
|
|
|
After the documentation, leave a *BLANK* line, and then add a
|
|
|
|
copyright and licence notice block like this one:
|
|
|
|
|
|
|
|
#=============================================================================
|
|
|
|
# Copyright 2009-2011 Your Name
|
|
|
|
#
|
|
|
|
# Distributed under the OSI-approved BSD License (the "License");
|
|
|
|
# see accompanying file Copyright.txt for details.
|
|
|
|
#
|
|
|
|
# This software is distributed WITHOUT ANY WARRANTY; without even the
|
|
|
|
# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
|
|
|
# See the License for more information.
|
|
|
|
#=============================================================================
|
|
|
|
# (To distribute this file outside of CMake, substitute the full
|
|
|
|
# License text for the above reference.)
|
|
|
|
|
|
|
|
The layout of the notice block is strictly enforced by the ModuleNotices test.
|
|
|
|
Only the year range and name may be changed freely.
|
|
|
|
|
2013-03-26 17:52:30 +00:00
|
|
|
A FindXxx.cmake module will typically be loaded by the command
|
2006-01-27 18:07:23 +00:00
|
|
|
|
2013-03-26 17:52:30 +00:00
|
|
|
FIND_PACKAGE(Xxx [major[.minor[.patch[.tweak]]]] [EXACT]
|
2009-02-16 15:33:09 +00:00
|
|
|
[QUIET] [[REQUIRED|COMPONENTS] [components...]])
|
2008-01-21 13:48:33 +00:00
|
|
|
|
|
|
|
If any version numbers are given to the command it will set the
|
2008-09-10 14:11:48 +00:00
|
|
|
following variables before loading the module:
|
|
|
|
|
2013-03-26 17:52:30 +00:00
|
|
|
Xxx_FIND_VERSION = full requested version string
|
|
|
|
Xxx_FIND_VERSION_MAJOR = major version if requested, else 0
|
|
|
|
Xxx_FIND_VERSION_MINOR = minor version if requested, else 0
|
|
|
|
Xxx_FIND_VERSION_PATCH = patch version if requested, else 0
|
|
|
|
Xxx_FIND_VERSION_TWEAK = tweak version if requested, else 0
|
|
|
|
Xxx_FIND_VERSION_COUNT = number of version components, 0 to 4
|
|
|
|
Xxx_FIND_VERSION_EXACT = true if EXACT option was given
|
2008-09-10 14:11:48 +00:00
|
|
|
|
2008-01-29 01:38:48 +00:00
|
|
|
If the find module supports versioning it should locate a version of
|
|
|
|
the package that is compatible with the version requested. If a
|
|
|
|
compatible version of the package cannot be found the module should
|
|
|
|
not report success. The version of the package found should be stored
|
2013-03-26 17:52:30 +00:00
|
|
|
in "Xxx_VERSION..." version variables documented by the module.
|
2006-01-27 18:07:23 +00:00
|
|
|
|
|
|
|
If the QUIET option is given to the command it will set the variable
|
2013-03-26 17:52:30 +00:00
|
|
|
Xxx_FIND_QUIETLY to true before loading the FindXxx.cmake module. If
|
2006-01-27 18:07:23 +00:00
|
|
|
this variable is set the module should not complain about not being
|
2007-07-19 13:00:51 +00:00
|
|
|
able to find the package. If the
|
2006-01-27 18:07:23 +00:00
|
|
|
REQUIRED option is given to the command it will set the variable
|
2013-03-26 17:52:30 +00:00
|
|
|
Xxx_FIND_REQUIRED to true before loading the FindXxx.cmake module. If
|
2006-01-27 18:07:23 +00:00
|
|
|
this variable is set the module should issue a FATAL_ERROR if the
|
2012-03-18 16:26:24 +00:00
|
|
|
package cannot be found.
|
2006-07-21 19:16:23 +00:00
|
|
|
If neither the QUIET nor REQUIRED options are given then the
|
2013-03-26 17:52:30 +00:00
|
|
|
FindXxx.cmake module should look for the package and complain without
|
2006-07-21 19:16:23 +00:00
|
|
|
error if the module is not found.
|
2007-07-19 13:00:51 +00:00
|
|
|
|
2012-10-04 19:54:40 +00:00
|
|
|
FIND_PACKAGE() will set the variable CMAKE_FIND_PACKAGE_NAME to
|
|
|
|
contain the actual name of the package.
|
|
|
|
|
2012-09-19 19:38:29 +00:00
|
|
|
A package can provide sub-components.
|
2012-03-18 16:26:24 +00:00
|
|
|
Those components can be listed after the COMPONENTS (or REQUIRED)
|
|
|
|
or OPTIONAL_COMPONENTS keywords. The set of all listed components will be
|
2013-03-26 17:52:30 +00:00
|
|
|
specified in a Xxx_FIND_COMPONENTS variable.
|
|
|
|
For each package-specific component, say Yyy, a variable Xxx_FIND_REQUIRED_Yyy
|
2012-03-18 16:26:24 +00:00
|
|
|
will be set to true if it listed after COMPONENTS and it will be set to false
|
|
|
|
if it was listed after OPTIONAL_COMPONENTS.
|
2013-03-26 17:52:30 +00:00
|
|
|
Using those variables a FindXxx.cmake module and also a XxxConfig.cmake package
|
2012-03-18 16:26:24 +00:00
|
|
|
configuration file can determine whether and which components have been requested,
|
|
|
|
and whether they were requested as required or as optional.
|
2013-03-26 17:52:30 +00:00
|
|
|
For each of the requested components a Xxx_Yyy_FOUND variable should be set
|
2012-03-18 16:26:24 +00:00
|
|
|
accordingly.
|
2013-03-26 17:52:30 +00:00
|
|
|
The per-package Xxx_FOUND variable should be only set to true if all requested
|
2012-03-18 16:26:24 +00:00
|
|
|
required components have been found. A missing optional component should not
|
2013-03-26 17:52:30 +00:00
|
|
|
keep the Xxx_FOUND variable from being set to true.
|
|
|
|
If the package provides Xxx_INCLUDE_DIRS and Xxx_LIBRARIES variables, the include
|
2012-03-18 16:26:24 +00:00
|
|
|
dirs and libraries for all components which were requested and which have been
|
|
|
|
found should be added to those two variables.
|
|
|
|
|
|
|
|
To get this behaviour you can use the FIND_PACKAGE_HANDLE_STANDARD_ARGS()
|
2007-07-19 13:00:51 +00:00
|
|
|
macro, as an example see FindJPEG.cmake.
|
2009-09-30 13:53:48 +00:00
|
|
|
|
2009-11-02 16:50:33 +00:00
|
|
|
For internal implementation, it's a generally accepted convention that variables starting with
|
|
|
|
underscore are for temporary use only. (variable starting with an underscore
|
|
|
|
are not intended as a reserved prefix).
|