kolan/CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge topic 'ExactCaseReadmeTxt'

Browse Source 
5479251 Modules/readme.txt: make lines a bit shorter for easier readability
140692d Modules/readme.txt: switch from "XXX" to "Xxx"
This commit is contained in:
Brad King 2013-03-28 10:42:24 -04:00 committed by CMake Topic Stage
commit 1c7833e7ae
1 changed files with 65 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

115
Modules/readme.txt
View File

@ -1,50 +1,65 @@
For more information about how to contribute modules to CMake, see this page: For more information about how to contribute modules to CMake, see this page:
http://www.itk.org/Wiki/CMake:Module_Maintainers http://www.itk.org/Wiki/CMake:Module_Maintainers
Note to authors of FindXXX.cmake files Note to authors of FindXxx.cmake files
We would like all FindXXX.cmake files to produce consistent variable names. We would like all FindXxx.cmake files to produce consistent variable names.
Please use the following consistent variable names for general use. Please use the following consistent variable names for general use.
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_INCLUDE_DIRS The final set of include directories listed in one variable for use by client code.
XXX_LIBRARIES The libraries to link against to use XXX. These should include full paths. This should not be a cache entry. 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> Xxx_LIBRARIES The libraries to link against to use Xxx. These should include full paths.
XXX_EXECUTABLE Where to find the XXX tool. This should not be a cache entry.
XXX_YYY_EXECUTABLE Where to find the YYY tool that comes with XXX. Xxx_DEFINITIONS Definitions to use when compiling code that uses Xxx. This really shouldn't include options such
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. as (-DHAS_JPEG)that a client source-code file uses to decide whether to #include <jpeg.h>
XXX_ROOT_DIR Where to find the base directory of XXX. Xxx_EXECUTABLE Where to find the Xxx tool.
XXX_VERSION_YY Expect Version YY if true. Make sure at most one of these is ever true. Xxx_Yyy_EXECUTABLE Where to find the Yyy tool that comes with Xxx.
XXX_WRAP_YY If False, do not try to use the relevent CMake wrapping command. Xxx_LIBRARY_DIRS Optionally, the final set of library directories listed in one variable for use by client code.
XXX_YY_FOUND If False, optional YY part of XXX sytem is not available. This should not be a cache entry.
XXX_FOUND Set to false, or undefined, if we haven't found, or don't want to use XXX. Xxx_ROOT_DIR Where to find the base directory of Xxx.
XXX_NOT_FOUND_MESSAGE Should be set by config-files in the case that it has set XXX_FOUND to FALSE. Xxx_VERSION_Yy Expect Version Yy if true. Make sure at most one of these is ever true.
Xxx_WRAP_Yy If False, do not try to use the relevant CMake wrapping command.
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.
The contained message will be printed by the find_package() command and by 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. find_package_handle_standard_args() to inform the user about the problem.
XXX_RUNTIME_LIBRARY_DIRS Optionally, the runtime library search path for use when running an executable linked to shared libraries. Xxx_RUNTIME_LIBRARY_DIRS Optionally, the runtime library search path for use when running an executable linked to
shared libraries.
The list should be used by user code to create the PATH on windows or LD_LIBRARY_PATH on unix. 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. This should not be a cache entry.
XXX_VERSION_STRING A human-readable string containing the version of the package found, if any. 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_MAJOR The major version of the package found, if any.
XXX_VERSION_MINOR The minor 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. Xxx_VERSION_PATCH The patch version of the package found, if any.
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) 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)
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. 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.
XXX_LIBRARY Name of XXX Library. A User may set this and XXX_INCLUDE_DIR to ignore to force non-use of XXX. 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. Xxx_Yy_LIBRARY Name of Yy library that is part of the Xxx system. It may or may not be required to use Xxx.
XXX_INCLUDE_DIR Where to find xxx.h, etc. (XXX_INCLUDE_PATH was considered bad because a path includes an actual filename.) Xxx_INCLUDE_DIR Where to find xxx.h, etc. (Xxx_INCLUDE_PATH was considered bad because a path includes an
XXX_YY_INCLUDE_DIR Where to find xxx_yy.h, etc. actual filename.)
Xxx_Yy_INCLUDE_DIR Where to find xxx_yy.h, etc.
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. 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.
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. 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.
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. 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.
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: 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:
1. The brief description of the module, this is done by: 1. The brief description of the module, this is done by:
# - a small description # - a small description
@ -67,7 +82,7 @@ For example:
# VAR_REALLY_COOL - cool right? # VAR_REALLY_COOL - cool right?
# #
Test the documentation formatting by running "cmake --help-module FindXXX". Test the documentation formatting by running "cmake --help-module FindXxx".
Edit the comments until the output of this command looks satisfactory. Edit the comments until the output of this command looks satisfactory.
To have a .cmake file in this directory NOT show up in the To have a .cmake file in this directory NOT show up in the
@ -93,38 +108,38 @@ copyright and licence notice block like this one:
The layout of the notice block is strictly enforced by the ModuleNotices test. The layout of the notice block is strictly enforced by the ModuleNotices test.
Only the year range and name may be changed freely. Only the year range and name may be changed freely.
A FindXXX.cmake module will typically be loaded by the command A FindXxx.cmake module will typically be loaded by the command
FIND_PACKAGE(XXX [major[.minor[.patch[.tweak]]]] [EXACT] FIND_PACKAGE(Xxx [major[.minor[.patch[.tweak]]]] [EXACT]
[QUIET] [[REQUIRED|COMPONENTS] [components...]]) [QUIET] [[REQUIRED|COMPONENTS] [components...]])
If any version numbers are given to the command it will set the If any version numbers are given to the command it will set the
following variables before loading the module: following variables before loading the module:
XXX_FIND_VERSION = full requested version string Xxx_FIND_VERSION = full requested version string
XXX_FIND_VERSION_MAJOR = major version if requested, else 0 Xxx_FIND_VERSION_MAJOR = major version if requested, else 0
XXX_FIND_VERSION_MINOR = minor 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_PATCH = patch version if requested, else 0
XXX_FIND_VERSION_TWEAK = tweak 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_COUNT = number of version components, 0 to 4
XXX_FIND_VERSION_EXACT = true if EXACT option was given Xxx_FIND_VERSION_EXACT = true if EXACT option was given
If the find module supports versioning it should locate a version of If the find module supports versioning it should locate a version of
the package that is compatible with the version requested. If a the package that is compatible with the version requested. If a
compatible version of the package cannot be found the module should compatible version of the package cannot be found the module should
not report success. The version of the package found should be stored not report success. The version of the package found should be stored
in "XXX_VERSION..." version variables documented by the module. in "Xxx_VERSION..." version variables documented by the module.
If the QUIET option is given to the command it will set the variable If the QUIET option is given to the command it will set the variable
XXX_FIND_QUIETLY to true before loading the FindXXX.cmake module. If Xxx_FIND_QUIETLY to true before loading the FindXxx.cmake module. If
this variable is set the module should not complain about not being this variable is set the module should not complain about not being
able to find the package. If the able to find the package. If the
REQUIRED option is given to the command it will set the variable REQUIRED option is given to the command it will set the variable
XXX_FIND_REQUIRED to true before loading the FindXXX.cmake module. If Xxx_FIND_REQUIRED to true before loading the FindXxx.cmake module. If
this variable is set the module should issue a FATAL_ERROR if the this variable is set the module should issue a FATAL_ERROR if the
package cannot be found. package cannot be found.
If neither the QUIET nor REQUIRED options are given then the If neither the QUIET nor REQUIRED options are given then the
FindXXX.cmake module should look for the package and complain without FindXxx.cmake module should look for the package and complain without
error if the module is not found. error if the module is not found.
FIND_PACKAGE() will set the variable CMAKE_FIND_PACKAGE_NAME to FIND_PACKAGE() will set the variable CMAKE_FIND_PACKAGE_NAME to
@ -133,19 +148,19 @@ contain the actual name of the package.
A package can provide sub-components. A package can provide sub-components.
Those components can be listed after the COMPONENTS (or REQUIRED) Those components can be listed after the COMPONENTS (or REQUIRED)
or OPTIONAL_COMPONENTS keywords. The set of all listed components will be or OPTIONAL_COMPONENTS keywords. The set of all listed components will be
specified in a XXX_FIND_COMPONENTS variable. specified in a Xxx_FIND_COMPONENTS variable.
For each package-specific component, say Yyy, a variable XXX_FIND_REQUIRED_Yyy For each package-specific component, say Yyy, a variable Xxx_FIND_REQUIRED_Yyy
will be set to true if it listed after COMPONENTS and it will be set to false will be set to true if it listed after COMPONENTS and it will be set to false
if it was listed after OPTIONAL_COMPONENTS. if it was listed after OPTIONAL_COMPONENTS.
Using those variables a FindXXX.cmake module and also a XXXConfig.cmake package Using those variables a FindXxx.cmake module and also a XxxConfig.cmake package
configuration file can determine whether and which components have been requested, configuration file can determine whether and which components have been requested,
and whether they were requested as required or as optional. and whether they were requested as required or as optional.
For each of the requested components a XXX_Yyy_FOUND variable should be set For each of the requested components a Xxx_Yyy_FOUND variable should be set
accordingly. accordingly.
The per-package XXX_FOUND variable should be only set to true if all requested The per-package Xxx_FOUND variable should be only set to true if all requested
required components have been found. A missing optional component should not required components have been found. A missing optional component should not
keep the XXX_FOUND variable from being set to true. keep the Xxx_FOUND variable from being set to true.
If the package provides XXX_INCLUDE_DIRS and XXX_LIBRARIES variables, the include If the package provides Xxx_INCLUDE_DIRS and Xxx_LIBRARIES variables, the include
dirs and libraries for all components which were requested and which have been dirs and libraries for all components which were requested and which have been
found should be added to those two variables. found should be added to those two variables.