CMake/Modules
Brad King ee72d5740b ENH: Adding CMAKE_EXPORT_BUILD_SETTINGS and CMAKE_IMPORT_BUILD_SETTINGS macro. 2002-12-05 09:46:30 -05:00
..
Platform determine CMAKE_MAKE_PROGRAM in EnableLanguage 2002-12-03 16:19:16 -05:00
CMakeBackwardCompatibilityC.cmake BUG: fix for thread and cache override 2002-11-18 15:14:44 -05:00
CMakeBackwardCompatibilityCXX.cmake have to cache ansi_cxxflags 2002-11-21 13:28:03 -05:00
CMakeBorlandFindMake.cmake determine CMAKE_MAKE_PROGRAM in EnableLanguage 2002-12-03 16:19:16 -05:00
CMakeBuildSettings.cmake.in ENH: Adding CMAKE_EXPORT_BUILD_SETTINGS and CMAKE_IMPORT_BUILD_SETTINGS macro. 2002-12-05 09:46:30 -05:00
CMakeCCompiler.cmake.in BUG: use CMAKE_COMPILER_IS_GNUCC not CMAKE_COMPILER_IS_GNUGCC 2002-11-20 15:23:14 -05:00
CMakeCXXCompiler.cmake.in clean up flags with _init flags 2002-11-11 12:31:46 -05:00
CMakeDefaultMakeRuleVariables.cmake correctly place both LINK_FLAGS and CXX_LINK_FLAGS and C_LINK_FLAGS into all the rules 2002-12-03 10:47:07 -05:00
CMakeDetermineCCompiler.cmake allow flags to be in the CC and CXX environment variables 2002-11-19 18:17:17 -05:00
CMakeDetermineCXXCompiler.cmake allow flags to be in the CC and CXX environment variables 2002-11-19 18:17:17 -05:00
CMakeDetermineSystem.cmake Complete rework of makefile generators expect trouble 2002-11-08 15:46:08 -05:00
CMakeExportBuildSettings.cmake ENH: Adding CMAKE_EXPORT_BUILD_SETTINGS and CMAKE_IMPORT_BUILD_SETTINGS macro. 2002-12-05 09:46:30 -05:00
CMakeImportBuildSettings.cmake ENH: Adding CMAKE_EXPORT_BUILD_SETTINGS and CMAKE_IMPORT_BUILD_SETTINGS macro. 2002-12-05 09:46:30 -05:00
CMakeLists.txt add install stuff for platform directory 2002-11-11 11:43:23 -05:00
CMakeNMakeFindMake.cmake determine CMAKE_MAKE_PROGRAM in EnableLanguage 2002-12-03 16:19:16 -05:00
CMakePrintSystemInformation.cmake Complete rework of makefile generators expect trouble 2002-11-08 15:46:08 -05:00
CMakeSystem.cmake.in clean up flags with _init flags 2002-11-11 12:31:46 -05:00
CMakeSystemSpecificInformation.cmake determine CMAKE_MAKE_PROGRAM in EnableLanguage 2002-12-03 16:19:16 -05:00
CMakeTestGNU.c test for gnu compiler 2002-10-22 18:17:07 -04:00
CMakeUnixFindMake.cmake BUG: Removed stray debugging message. 2002-12-04 16:59:05 -05:00
CheckFunctionExists.c Add two commonly used modules. First one checks if the function exists, the second one checks the size of type 2002-09-20 13:16:50 -04:00
CheckFunctionExists.cmake Add more messages, make messages look the same, add checks if test was already successfull 2002-11-18 10:52:09 -05:00
CheckIncludeFile.c.in Simplify checking for headers 2002-09-20 14:16:43 -04:00
CheckIncludeFile.cmake Add more messages, make messages look the same, add checks if test was already successfull 2002-11-18 10:52:09 -05:00
CheckIncludeFile.cxx.in Complete rework of makefile generators expect trouble 2002-11-08 15:46:08 -05:00
CheckIncludeFileCXX.cmake try to fix check for ansi stream 2002-11-21 14:45:21 -05:00
CheckLibraryExists.cmake Add more messages, make messages look the same, add checks if test was already successfull 2002-11-18 10:52:09 -05:00
CheckLibraryExists.lists.in Initial attempt to check if library exists 2002-09-24 16:36:56 -04:00
CheckSizeOf.c Add two commonly used modules. First one checks if the function exists, the second one checks the size of type 2002-09-20 13:16:50 -04:00
CheckSizeOf.cmake Add more messages, make messages look the same, add checks if test was already successfull 2002-11-18 10:52:09 -05:00
CheckVariableExists.c ENH: Added CHECK_VARIABLE_EXISTS macro. 2002-11-21 10:11:46 -05:00
CheckVariableExists.cmake ENH: Added CHECK_VARIABLE_EXISTS macro. 2002-11-21 10:11:46 -05:00
Dart.cmake Add option to control number of errors sent to dashbaord 2002-10-11 11:22:16 -04:00
Documentation.cmake Add module to find gnuplot 2002-02-04 18:41:47 -05:00
DummyCXXFile.cxx add checks for ansi flags and not hard code them 2002-11-21 12:52:54 -05:00
FindAVIFile.cmake Fixed mistake in comments 2002-09-03 06:10:06 -04:00
FindCABLE.cmake BUG: Should not load CMAKE_INSTALL_PREFIX from the cache. 2002-10-11 10:14:19 -04:00
FindCurses.cmake ENH: Added /lib to curses search path. 2001-12-12 12:05:20 -05:00
FindCygwin.cmake Remove unneeded test and code duplication. Add WIN32 test. Make all ADVANCED. 2001-12-04 10:55:17 -05:00
FindDart.cmake ENH: look for Dart in c: 2002-02-25 13:20:48 -05:00
FindDoxygen.cmake Remove unneeded test and code duplication. Add WIN32 test. Make all ADVANCED. 2001-12-04 10:55:17 -05:00
FindFLTK.cmake ENH: description of variables now follows other style in other .cmake files. 2002-12-03 13:46:45 -05:00
FindGCCXML.cmake ENH: Updated for version 0.2 of GCC-XML. 2002-04-17 14:51:58 -04:00
FindGLU.cmake Fixed mistake in comments 2002-09-03 06:10:06 -04:00
FindGLUT.cmake ENH: Description of variables now specifies that the full path is required. 2002-12-03 13:44:50 -05:00
FindGTK.cmake GL should not be a completely necessary thing for finding GTK. This will find gtk and GL but also just GTK 2002-09-18 08:15:04 -04:00
FindGnuplot.cmake Add module to find gnuplot 2002-02-04 18:41:47 -05:00
FindHhc.cmake Remove unneeded test and code duplication. Add WIN32 test. Make all ADVANCED. 2001-12-04 10:55:17 -05:00
FindITK.cmake ENH: Enhanced FindITK supporting use of ITK from an install tree or a build tree. Only one cache entry is brought into user's project, called "ITK_DIR". This is the location of an ITKConfig.cmake file from which other settings are loaded. 2002-11-06 18:40:13 -05:00
FindImageMagick.cmake Module to find tools from the ImageMagick package. 2002-12-03 14:15:51 -05:00
FindJNI.cmake Clean find for Python, add find for python 2.2 on windows, cleanup java on windows and add java 1.4 support 2002-11-14 09:38:45 -05:00
FindJPEG.cmake Fixed mistake in comments 2002-09-03 06:10:06 -04:00
FindJava.cmake Clean find for Python, add find for python 2.2 on windows, cleanup java on windows and add java 1.4 support 2002-11-14 09:38:45 -05:00
FindLATEX.cmake ENH: Now also locates the "makeindex" program. 2002-11-20 14:40:51 -05:00
FindMFC.cmake A simple FindMFC module for consistency 2002-09-03 12:29:03 -04:00
FindMPEG.cmake Add an MPEG finder in the new format - functionality copied from VXL. 2002-09-03 08:24:48 -04:00
FindMPI.cmake Add mpi search paths for Debian 2002-04-18 15:58:11 -04:00
FindOpenGL.cmake FIX: minor fix, OPENGL_INCLUDE_PATH was set 2 times 2002-11-12 10:47:43 -05:00
FindPNG.cmake I copied a bit too much VXL functionality here. Oops 2002-09-03 09:00:06 -04:00
FindPerl.cmake Added PERL_FOUND 2002-09-03 08:33:56 -04:00
FindPythonLibs.cmake Clean find for Python, add find for python 2.2 on windows, cleanup java on windows and add java 1.4 support 2002-11-14 09:38:45 -05:00
FindQt.cmake Make QT variables advanced 2002-09-13 09:49:35 -04:00
FindSelfPackers.cmake Remove unneeded test and code duplication. Add WIN32 test. Make all ADVANCED. 2001-12-04 10:55:17 -05:00
FindTCL.cmake ENH: make stub stuff ADVANCED 2002-09-06 13:56:35 -04:00
FindTIFF.cmake Fixed mistake in comments 2002-09-03 06:10:06 -04:00
FindTclsh.cmake ENH: clean modules (doc, make stuff advanced, etc.) 2002-06-14 16:49:00 -04:00
FindThreads.cmake BUG: fix for thread and cache override 2002-11-18 15:14:44 -05:00
FindUnixCommands.cmake Remove unneeded test and code duplication. Add WIN32 test. Make all ADVANCED. 2001-12-04 10:55:17 -05:00
FindVTK.cmake ENH: Added support to find VTK 4.0. 2002-11-20 16:23:20 -05:00
FindWget.cmake Add helpful message for QT Windows users 2002-09-02 12:05:40 -04:00
FindWish.cmake Add better detection of wish 8.2 2002-05-14 08:42:35 -04:00
FindX11.cmake fix for nsl library and X11 2002-11-13 11:49:33 -05:00
FindZLIB.cmake This file should not be empty 2002-09-02 16:24:25 -04:00
FindwxWindows.cmake Change priorities 2002-11-25 17:57:30 -05:00
LinkQT.cmake Define a single expected format for the values defined in every FindXXX.cmake file. 2002-09-02 07:03:43 -04:00
TestBigEndian.c Add test for big endian 2002-10-01 15:56:18 -04:00
TestBigEndian.cmake Add append to write_file 2002-10-29 13:34:12 -05:00
TestCXXAcceptsFlag.cmake spelling error 2002-11-21 13:00:51 -05:00
TestForANSIForScope.cmake move ansi cxx flags stuff out of try compile and into cmake files 2002-11-21 14:11:53 -05:00
TestForANSIStreamHeaders.cmake try to fix check for ansi stream 2002-11-21 14:45:21 -05:00
TestForANSIStreamHeaders.cxx new try compile module 2002-09-12 11:14:50 -04:00
TestForAnsiForScope.cxx Complete rework of makefile generators expect trouble 2002-11-08 15:46:08 -05:00
TestForSTDNamespace.cmake fix order 2002-11-21 14:24:58 -05:00
TestForSTDNamespace.cxx Complete rework of makefile generators expect trouble 2002-11-08 15:46:08 -05:00
readme.txt Add important missing word to documentation 2002-09-06 11:00:51 -04:00

readme.txt

Note to authors of FindXXX.cmake files

We would like all FindXXX.cmake files to produce consistent variable names.

Please use the following consistent variable names for general use.

XXX_INCLUDE_DIR        	Where to find xxx.h, etc. If for some reason, you really need two paths, then that shouldn't be a problem - however, consider if you really should have two different FindXXX.cmake files. (XXX_INCLUDE_PATH was considered bad because a path includes an actual filename.)
XXX_LIBRARIES          	The libraries to link against to use XXX. These should include full paths.
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_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.

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_DIR 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.

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.

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.

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.