Modules/readme.txt

   1 Note to authors of FindXXX.cmake files
   2
   3 We would like all FindXXX.cmake files to produce consistent variable names.
   4
   5 Please use the following consistent variable names for general use.
   6
   7 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.
   8 XXX_LIBRARIES           The libraries to link against to use XXX. These should include full paths.  This should not be a cache entry.
   9 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>
  10 XXX_EXECUTABLE          Where to find the XXX tool.
  11 XXX_YYY_EXECUTABLE      Where to find the YYY tool that comes with XXX.
  12 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.
  13 XXX_ROOT_DIR            Where to find the base directory of XXX.
  14 XXX_VERSION_YY          Expect Version YY if true. Make sure at most one of these is ever true.
  15 XXX_WRAP_YY             If False, do not try to use the relevent CMake wrapping command.
  16 XXX_YY_FOUND            If False, optional YY part of XXX sytem is not available.
  17 XXX_FOUND               Set to false, or undefined, if we haven't found, or don't want to use XXX.
  18 XXX_RUNTIME_LIBRARY_DIRS Optionally, the runtime library search path for use when running an executable linked to shared libraries.
  19                          The list should be used by user code to create the PATH on windows or LD_LIBRARY_PATH on unix.
  20                          This should not be a cache entry.
  21 XXX_VERSION_STRING      A human-readable string containing the version of the package found, if any.
  22 XXX_VERSION_MAJOR       The major version of the package found, if any.
  23 XXX_VERSION_MINOR       The minor version of the package found, if any.
  24 XXX_VERSION_PATCH       The patch version of the package found, if any.
  25
  26 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)
  27
  28 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.
  29
  30 XXX_LIBRARY             Name of XXX Library. A User may set this and XXX_INCLUDE_DIR to ignore to force non-use of XXX.
  31 XXX_YY_LIBRARY          Name of YY library that is part of the XXX system. It may or may not be required to use XXX.
  32 XXX_INCLUDE_DIR         Where to find xxx.h, etc.  (XXX_INCLUDE_PATH was considered bad because a path includes an actual filename.)
  33 XXX_YY_INCLUDE_DIR      Where to find xxx_yy.h, etc.
  34
  35 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.
  36
  37 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.
  38
  39 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.
  40
  41 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:
  42
  43 1. The brief description of the module, this is done by:
  44 # - a small description
  45
  46 2. A paragraph of text.  This is done with all text that has a single
  47 space between the # and the text.  To create a new paragraph, just
  48 put a # with no text on the line.
  49
  50 3. A verbatim line.  This is done with two spaces between the # and the text.
  51
  52 For example:
  53
  54 # - This is a cool module
  55 # This module does really cool stuff.
  56 # It can do even more than you think.
  57 #
  58 # It even needs to paragraphs to tell you about it.
  59 # And it defines the following variables:
  60 #  VAR_COOL - this is great isn't it?
  61 #  VAR_REALLY_COOL - cool right?
  62 #
  63
  64 To have a .cmake file in this directory NOT show up in the
  65 modules documentation, you should start the file with a blank
  66 line.
  67
  68 A FindXXX.cmake module will typically be loaded by the command
  69
  70   FIND_PACKAGE(XXX [major[.minor[.patch[.tweak]]]] [EXACT]
  71                [QUIET] [REQUIRED [components...]])
  72
  73 If any version numbers are given to the command it will set the
  74 following variables before loading the module:
  75
  76   XXX_FIND_VERSION       = full requested version string
  77   XXX_FIND_VERSION_MAJOR = major version if requested, else 0
  78   XXX_FIND_VERSION_MINOR = minor version if requested, else 0
  79   XXX_FIND_VERSION_PATCH = patch version if requested, else 0
  80   XXX_FIND_VERSION_TWEAK = tweak version if requested, else 0
  81   XXX_FIND_VERSION_COUNT = number of version components, 0 to 4
  82   XXX_FIND_VERSION_EXACT = true if EXACT option was given
  83
  84 If the find module supports versioning it should locate a version of
  85 the package that is compatible with the version requested.  If a
  86 compatible version of the package cannot be found the module should
  87 not report success.  The version of the package found should be stored
  88 in "XXX_VERSION..." version variables docmented by the module.
  89
  90 If the QUIET option is given to the command it will set the variable
  91 XXX_FIND_QUIETLY to true before loading the FindXXX.cmake module.  If
  92 this variable is set the module should not complain about not being
  93 able to find the package.  If the
  94 REQUIRED option is given to the command it will set the variable
  95 XXX_FIND_REQUIRED to true before loading the FindXXX.cmake module.  If
  96 this variable is set the module should issue a FATAL_ERROR if the
  97 package cannot be found.  For each package-specific component, say
  98 YYY, listed after the REQUIRED option a variable XXX_FIND_REQUIRED_YYY
  99 to true.  The set of components listed will also be specified in a
 100 XXX_FIND_COMPONENTS variable.  This can be used by the FindXXX.cmake
 101 module to determine which sub-components of the package must be found.
 102 If neither the QUIET nor REQUIRED options are given then the
 103 FindXXX.cmake module should look for the package and complain without
 104 error if the module is not found.
 105
 106 To get this behaviour you can use the FIND_PACKAGE_HANDLE_STANDARD_ARGS()
 107 macro, as an example see FindJPEG.cmake.