CMake/Modules
Ken Martin d17830ee5e slight change in signature for TryCompile 2002-09-17 09:17:15 -04:00
..
CMakeLists.txt ENH: Added support for using backslash-style escaping in CMakeLists.txt file arguments. This allows double quotes to be used in arguments. 2001-07-17 09:54:05 -04:00
Dart.cmake Dart now has a configure option 2002-09-03 09:14:24 -04:00
Documentation.cmake Add module to find gnuplot 2002-02-04 18:41:47 -05:00
FindAVIFile.cmake Fixed mistake in comments 2002-09-03 06:10:06 -04:00
FindCABLE.cmake ENH: clean modules (doc, make stuff advanced, etc.) 2002-06-14 16:49:00 -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 Hide lots of values in the advanced list 2002-09-05 12:00:45 -04: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 Hide lots of values in the advanced list 2002-09-05 12:00:45 -04:00
FindGTK.cmake Hide lots of values in the advanced list 2002-09-05 12:00:45 -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 *** empty log message *** 2001-10-26 18:21:53 -04:00
FindJNI.cmake ENH: Added /usr/local/lib/java search paths. 2002-07-15 09:22:17 -04:00
FindJPEG.cmake Fixed mistake in comments 2002-09-03 06:10:06 -04:00
FindJava.cmake Add module that finds java executables. This module should find java, javac, and jar. 2002-07-08 09:30:02 -04: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: typo + bring back the OPENGL_gl_LIBRARY path that can be used to find GLU (was wiped out from FindGLU) 2002-09-10 13:32:45 -04: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 Oops, forgot the library name 2002-06-10 08:53:36 -04: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
FindUnixCommands.cmake Remove unneeded test and code duplication. Add WIN32 test. Make all ADVANCED. 2001-12-04 10:55:17 -05:00
FindVTK.cmake More finds for VTK 2002-04-01 08:08:55 -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 Hide lots of values in the advanced list 2002-09-05 12:00:45 -04:00
FindZLIB.cmake This file should not be empty 2002-09-02 16:24:25 -04:00
FindwxWindows.cmake FIX: 2002-08-09 08:33:04 -04: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
TestForANSIStreamHeaders.cmake slight change in signature for TryCompile 2002-09-17 09:17:15 -04:00
TestForANSIStreamHeaders.cxx new try compile module 2002-09-12 11:14:50 -04: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.