diff options
Diffstat (limited to 'Modules')
| -rw-r--r-- | Modules/readme.txt | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/Modules/readme.txt b/Modules/readme.txt index a292e20..dd52000 100644 --- a/Modules/readme.txt +++ b/Modules/readme.txt @@ -8,16 +8,16 @@ We would like all FindXXX.cmake files to produce consistent variable names. 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_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> -XXX_EXECUTABLE Where to find the XXX tool. -XXX_YYY_EXECUTABLE Where to find the YYY tool that comes with XXX. +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> +XXX_EXECUTABLE Where to find the XXX tool. +XXX_YYY_EXECUTABLE Where to find the YYY tool that comes with XXX. 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. -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. -XXX_WRAP_YY If False, do not try to use the relevent 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_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. +XXX_WRAP_YY If False, do not try to use the relevent 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_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. This should not be a cache entry. @@ -30,9 +30,9 @@ You do not have to provide all of the above variables. You should provide XXX_FO 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_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_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_INCLUDE_DIR Where to find xxx.h, etc. (XXX_INCLUDE_PATH was considered bad because a path includes an 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. |