diff options
35 files changed, 132 insertions, 140 deletions
diff --git a/Modules/FindMFC.cmake b/Modules/FindMFC.cmake index f5fa606bb7..7e3bcc118c 100644 --- a/Modules/FindMFC.cmake +++ b/Modules/FindMFC.cmake @@ -1,6 +1,6 @@ # - Find MFC on Windows # Find the native MFC - i.e. decide if this is an MS VC box. -# MFC_FOUND - Do not attempt to use MFC if "no" or undefined. +# MFC_FOUND - Was MFC support found # You don't need to include anything or link anything to use it. # Assume no MFC support diff --git a/Modules/FindMPEG.cmake b/Modules/FindMPEG.cmake index 465e151a9d..225b243693 100644 --- a/Modules/FindMPEG.cmake +++ b/Modules/FindMPEG.cmake @@ -1,7 +1,7 @@ # - Find the native MPEG includes and library # This module defines # MPEG_INCLUDE_DIR, where to find MPEG.h, etc. -# MPEG_LIBRARIES, the libraries to link against to use MPEG. +# MPEG_LIBRARIES, the libraries required to use MPEG. # MPEG_FOUND, If false, do not try to use MPEG. # also defined, but not for general use are # MPEG_mpeg2_LIBRARY, where to find the MPEG library. diff --git a/Modules/FindMPEG2.cmake b/Modules/FindMPEG2.cmake index 4c6e008ba3..4b54fe3fcd 100644 --- a/Modules/FindMPEG2.cmake +++ b/Modules/FindMPEG2.cmake @@ -1,7 +1,7 @@ # - Find the native MPEG2 includes and library # This module defines -# MPEG2_INCLUDE_DIR, where to find mpeg2dec/mpeg2.h, etc. -# MPEG2_LIBRARIES, the libraries to link against to use MPEG2. +# MPEG2_INCLUDE_DIR, path to mpeg2dec/mpeg2.h, etc. +# MPEG2_LIBRARIES, the libraries required to use MPEG2. # MPEG2_FOUND, If false, do not try to use MPEG2. # also defined, but not for general use are # MPEG2_mpeg2_LIBRARY, where to find the MPEG2 library. diff --git a/Modules/FindMPI.cmake b/Modules/FindMPI.cmake index 049f32d493..685111644b 100644 --- a/Modules/FindMPI.cmake +++ b/Modules/FindMPI.cmake @@ -2,7 +2,7 @@ # This module looks for MPI (Message Passing Interface) support # it will define the following values # MPI_INCLUDE_PATH = where mpi.h can be found -# MPI_LIBRARY = the library to link against (mpi mpich etc) +# MPI_LIBRARY = the library to link in (mpi mpich etc) FIND_PATH(MPI_INCLUDE_PATH mpi.h /usr/local/include diff --git a/Modules/FindMotif.cmake b/Modules/FindMotif.cmake index 6700e7e969..5c3871fe96 100644 --- a/Modules/FindMotif.cmake +++ b/Modules/FindMotif.cmake @@ -1,7 +1,7 @@ # - Try to find Motif (or lesstif) # Once done this will define: # MOTIF_FOUND - system has MOTIF -# MOTIF_INCLUDE_DIR - where the Motif include directory can be found +# MOTIF_INCLUDE_DIR - incude paths to use Motif # MOTIF_LIBRARIES - Link these to use Motif SET(MOTIF_FOUND 0) diff --git a/Modules/FindOpenGL.cmake b/Modules/FindOpenGL.cmake index d8d93b74f1..062e16dfd7 100644 --- a/Modules/FindOpenGL.cmake +++ b/Modules/FindOpenGL.cmake @@ -1,10 +1,10 @@ # - Try to find OpenGL # Once done this will define # -# OPENGL_FOUND - system has OpenGL and it should be used -# OPENGL_XMESA_FOUND - system has XMESA, and it should be used. -# OPENGL_GLU_FOUND - system has GLU and it should be used. -# OPENGL_INCLUDE_DIR - where the GL include directory can be found +# OPENGL_FOUND - system has OpenGL +# OPENGL_XMESA_FOUND - system has XMESA +# OPENGL_GLU_FOUND - system has GLU +# OPENGL_INCLUDE_DIR - the GL include directory # OPENGL_LIBRARIES - Link these to use OpenGL and GLU # # If you want to use just GL you can use these values diff --git a/Modules/FindPHP4.cmake b/Modules/FindPHP4.cmake index a58bbab293..b7d0714662 100644 --- a/Modules/FindPHP4.cmake +++ b/Modules/FindPHP4.cmake @@ -3,7 +3,7 @@ # and libraries are. It also determines what the name of the library is. This # code sets the following variables: # -# PHP4_INCLUDE_PATH = path to where object.h can be found +# PHP4_INCLUDE_PATH = path to where php.h can be found # PHP4_EXECUTABLE = full path to the php4 binary # diff --git a/Modules/FindPerl.cmake b/Modules/FindPerl.cmake index 71f49af6a5..65340b8959 100644 --- a/Modules/FindPerl.cmake +++ b/Modules/FindPerl.cmake @@ -1,7 +1,7 @@ # - Find perl # this module looks for Perl # -# PERL_EXECUTABLE - the full path to the Perl interpreter +# PERL_EXECUTABLE - the full path to perl # PERL_FOUND - If false, don't attempt to use perl. INCLUDE(FindCygwin) diff --git a/Modules/FindPerlLibs.cmake b/Modules/FindPerlLibs.cmake index 3372d852e8..1cfe7ef4c0 100644 --- a/Modules/FindPerlLibs.cmake +++ b/Modules/FindPerlLibs.cmake @@ -3,8 +3,8 @@ # and libraries are. It also determines what the name of the library is. This # code sets the following variables: # -# PERL_INCLUDE_PATH = path to where object.h can be found -# PERL_EXECUTABLE = full path to the perl binary +# PERL_INCLUDE_PATH = path to where perl.h is found +# PERL_EXECUTABLE = full path to the perl binary # SET(PERL_POSSIBLE_INCLUDE_PATHS diff --git a/Modules/FindPhysFS.cmake b/Modules/FindPhysFS.cmake index c56a72bfad..5912234afa 100644 --- a/Modules/FindPhysFS.cmake +++ b/Modules/FindPhysFS.cmake @@ -1,6 +1,6 @@ # - Locate PhysFS library # This module defines -# PHYSFS_LIBRARY, the name of the library to link against +# PHYSFS_LIBRARY, the name of the library to link with # PHYSFS_FOUND, if false, do not try to link to PHYSFS # PHYSFS_INCLUDE_DIR, where to find PHYSFS/PHYSFS.h # diff --git a/Modules/FindPike.cmake b/Modules/FindPike.cmake index 946df52e84..c0db37dbc2 100644 --- a/Modules/FindPike.cmake +++ b/Modules/FindPike.cmake @@ -3,7 +3,7 @@ # and libraries are. It also determines what the name of the library is. This # code sets the following variables: # -# PIKE_INCLUDE_PATH = path to where object.h can be found +# PIKE_INCLUDE_PATH = path to where program.h is found # PIKE_EXECUTABLE = full path to the pike binary # diff --git a/Modules/FindPythonInterp.cmake b/Modules/FindPythonInterp.cmake index bf89a08efd..c0c58058b4 100644 --- a/Modules/FindPythonInterp.cmake +++ b/Modules/FindPythonInterp.cmake @@ -2,8 +2,8 @@ # This module finds if Python interpreter is installed and determines where the # executables are. This code sets the following variables: # -# PYTHONINTERP_FOUND - Set to true when Python executable is found -# PYTHON_EXECUTABLE - The full path to the Python interpreter +# PYTHONINTERP_FOUND - Was the Python executable found +# PYTHON_EXECUTABLE - path to the Python interpreter # FIND_PROGRAM(PYTHON_EXECUTABLE diff --git a/Modules/FindPythonLibs.cmake b/Modules/FindPythonLibs.cmake index acf3f84a20..d76c34864e 100644 --- a/Modules/FindPythonLibs.cmake +++ b/Modules/FindPythonLibs.cmake @@ -3,9 +3,9 @@ # include files and libraries are. It also determines what the name of # the library is. This code sets the following variables: # -# PYTHON_LIBRARIES = the full path to the library found -# PYTHON_INCLUDE_PATH = the path to where Python.h can be found -# PYTHON_DEBUG_LIBRARIES = the full path to the debug library found +# PYTHON_LIBRARIES = path to the python library +# PYTHON_INCLUDE_PATH = path to where Python.h is found +# PYTHON_DEBUG_LIBRARIES = path to the debug library # INCLUDE(CMakeFindFrameworks) diff --git a/Modules/FindQt.cmake b/Modules/FindQt.cmake index 82af7cd9ac..4bc8fffcb1 100644 --- a/Modules/FindQt.cmake +++ b/Modules/FindQt.cmake @@ -9,9 +9,10 @@ # Once the user sets DESIRED_QT_VERSION, then the FindQt3 or FindQt4 module # is included. # -# QT_REQUIRED if this is set to TRUE then if CMake can not find -# QT4 or QT3 an error is raised and a message is sent -# to the user. +# QT_REQUIRED if this is set to TRUE then if CMake can +# not find QT4 or QT3 an error is raised +# and a message is sent to the user. +# # DESIRED_QT_VERSION OPTION is created # QT4_INSTALLED is set to TRUE if qt4 is found. # QT3_INSTALLED is set to TRUE if qt3 is found. diff --git a/Modules/FindQt4.cmake b/Modules/FindQt4.cmake index ec50c88bd3..655c733883 100644 --- a/Modules/FindQt4.cmake +++ b/Modules/FindQt4.cmake @@ -1,11 +1,10 @@ # - Find QT 4 # This module can be used to find Qt4. -# This module defines: -# QT_USE_FILE A CMake file that can be included to compile -# Qt 4 applications and libraries. By default, -# the QtCore and QtGui libraries are loaded. -# This behavior can be changed by setting one -# or more of the following variables to true: +# This module defines a number of key variables and macros. First is +# QT_USE_FILE which is the path to a CMake file that can be included to compile +# Qt 4 applications and libraries. By default, the QtCore and QtGui +# libraries are loaded. This behavior can be changed by setting one or more +# of the following variables to true: # QT_DONT_USE_QTCORE # QT_DONT_USE_QTGUI # QT_USE_QT3SUPPORT @@ -17,16 +16,15 @@ # QT_USE_QTOPENGL # QT_USE_QTSQL # QT_USE_QTXML -# All the libraries required are stored in a -# variable called QT_LIBRARIES. Add this -# variable to your TARGET_LINK_LIBRARIES. +# All the libraries required are stored in a variable called QT_LIBRARIES. +# Add this variable to your TARGET_LINK_LIBRARIES. # # macro QT4_WRAP_CPP(outfiles inputfile ... ) # macro QT4_WRAP_UI(outfiles inputfile ... ) # macro QT4_ADD_RESOURCE(outfiles inputfile ... ) # -# QT_FOUND If false, don't try to use Qt. -# QT4_FOUND If false, don't try to use Qt 4. +# QT_FOUND If false, don't try to use Qt. +# QT4_FOUND If false, don't try to use Qt 4. # # QT_QTCORE_FOUND True if QtCore was found. # QT_QTGUI_FOUND True if QtGui was found. @@ -98,14 +96,14 @@ # # These are around for backwards compatibility # they will be set -# QT_WRAP_CPP Set true if QT_MOC_EXECUTABLE is found -# QT_WRAP_UI Set true if QT_UIC_EXECUTABLE is found +# QT_WRAP_CPP Set true if QT_MOC_EXECUTABLE is found +# QT_WRAP_UI Set true if QT_UIC_EXECUTABLE is found # # These variables do _NOT_ have any effect anymore (compared to FindQt.cmake) # QT_MT_REQUIRED Qt4 is now always multithreaded # # These variables are set to "" Because Qt structure changed -# (They make no sence in Qt4) +# (They make no sense in Qt4) # QT_QT_LIBRARY Qt-Library is now splitt # QT_QTMAIN_LIBRARY Qt-Library is now splitt diff --git a/Modules/FindRuby.cmake b/Modules/FindRuby.cmake index 9c79a5f140..5052614fd4 100644 --- a/Modules/FindRuby.cmake +++ b/Modules/FindRuby.cmake @@ -3,8 +3,8 @@ # and libraries are. It also determines what the name of the library is. This # code sets the following variables: # -# RUBY_INCLUDE_PATH = path to where object.h can be found -# RUBY_EXECUTABLE = full path to the ruby binary +# RUBY_INCLUDE_PATH = path to where ruby.h can be found +# RUBY_EXECUTABLE = full path to the ruby binary # SET(RUBY_POSSIBLE_INCLUDE_PATHS diff --git a/Modules/FindSDL.cmake b/Modules/FindSDL.cmake index b7a1c6d8bb..21b96dfa23 100644 --- a/Modules/FindSDL.cmake +++ b/Modules/FindSDL.cmake @@ -1,6 +1,6 @@ -# - Locate SDL library +# - Locate the SDL library # This module defines -# SDL_LIBRARY, the name of the library to link against +# SDL_LIBRARY, the library to link against # SDL_FOUND, if false, do not try to link to SDL # SDL_INCLUDE_DIR, where to find SDL.h # diff --git a/Modules/FindSDL_image.cmake b/Modules/FindSDL_image.cmake index b09d231d6f..4cef461889 100644 --- a/Modules/FindSDL_image.cmake +++ b/Modules/FindSDL_image.cmake @@ -1,6 +1,6 @@ # - Locate SDL_image library # This module defines -# SDLIMAGE_LIBRARY, the name of the library to link against +# SDLIMAGE_LIBRARY, the library to link against # SDLIMAGE_FOUND, if false, do not try to link to SDL # SDLIMAGE_INCLUDE_DIR, where to find SDL/SDL.h # diff --git a/Modules/FindSDL_mixer.cmake b/Modules/FindSDL_mixer.cmake index 6c27f1c98a..bea993dd3c 100644 --- a/Modules/FindSDL_mixer.cmake +++ b/Modules/FindSDL_mixer.cmake @@ -1,6 +1,6 @@ -# - Locate SDL_mixer library +# - Locate the SDL_mixer library # This module defines -# SDLMIXER_LIBRARY, the name of the library to link against +# SDLMIXER_LIBRARY, library to link against # SDLMIXER_FOUND, if false, do not try to link to SDL # SDLMIXER_INCLUDE_DIR, where to find SDL/SDL.h # diff --git a/Modules/FindSDL_net.cmake b/Modules/FindSDL_net.cmake index f5296cd282..de4d533a43 100644 --- a/Modules/FindSDL_net.cmake +++ b/Modules/FindSDL_net.cmake @@ -1,6 +1,6 @@ -# - Locate SDL_net library +# - Locate the SDL_net library # This module defines -# SDLNET_LIBRARY, the name of the library to link against +# SDLNET_LIBRARY, the library to link against # SDLNET_FOUND, if false, do not try to link against # SDLNET_INCLUDE_DIR, where to find the headers # diff --git a/Modules/FindSDL_sound.cmake b/Modules/FindSDL_sound.cmake index 025d634c63..be9f54c761 100644 --- a/Modules/FindSDL_sound.cmake +++ b/Modules/FindSDL_sound.cmake @@ -1,7 +1,7 @@ # - Locates the SDL_sound library # This module depends on SDL being found and # must be called AFTER FindSDL.cmake is called. - +# # This module defines # SDL_SOUND_INCLUDE_DIR, where to find SDL_sound.h # SDL_SOUND_FOUND, if false, do not try to link to SDL @@ -24,29 +24,31 @@ # FLAC_LIBRARY # SPEEX_LIBRARY # -# Typically, you should not use these variables directly, and you should use -# SDL_SOUND_LIBRARIES which contains SDL_SOUND_LIBRARY and the other audio libraries -# (if needed) to successfully compile on your system . +# Typically, you should not use these variables directly, and you should use +# SDL_SOUND_LIBRARIES which contains SDL_SOUND_LIBRARY and the other audio +# libraries (if needed) to successfully compile on your system . # # Created by Eric Wing. -# This module is a bit more complicated than the other FindSDL* family modules. -# The reason is that SDL_sound can be compiled in a large variety of different ways -# which are independent of platform. SDL_sound may dynamically link against other 3rd -# party libraries to get additional codec support, such as Ogg Vorbis, SMPEG, ModPlug, -# MikMod, FLAC, Speex, and potentially others. -# Under some circumstances which I don't fully understand, -# there seems to be a requirement -# that dependent libraries of libraries you use must also be explicitly -# linked against in order to successfully compile. SDL_sound does not currently -# have any system in place to know how it was compiled. -# So this CMake module does the hard work in trying to discover which 3rd party -# libraries are required for building (if any). -# This module uses a brute force approach to create a test program that uses SDL_sound, -# and then tries to build it. If the build fails, it parses the error output for -# known symbol names to figure out which libraries are needed. # -# Responds to the $SDLDIR and $SDLSOUNDDIR environmental variable that would -# correspond to the ./configure --prefix=$SDLDIR used in building SDL. +# This module is a bit more complicated than the other FindSDL* family +# modules. The reason is that SDL_sound can be compiled in a large variety +# of different ways which are independent of platform. SDL_sound may +# dynamically link against other 3rd party libraries to get additional codec +# support, such as Ogg Vorbis, SMPEG, ModPlug, MikMod, FLAC, Speex, and +# potentially others. Under some circumstances which I don't fully +# understand, there seems to be a requirement that dependent libraries of +# libraries you use must also be explicitly linked against in order to +# successfully compile. SDL_sound does not currently have any system in place +# to know how it was compiled. So this CMake module does the hard work in +# trying to discover which 3rd party libraries are required for building (if +# any). +# +# This module uses a brute force approach to create a test program that uses +# SDL_sound, and then tries to build it. If the build fails, it parses the +# error output for known symbol names to figure out which libraries are +# needed. Responds to the $SDLDIR and $SDLSOUNDDIR environmental variable +# that would correspond to the ./configure --prefix=$SDLDIR used in building +# SDL. # # On OSX, this will prefer the Framework version (if found) over others. # People will have to manually change the cache values of diff --git a/Modules/FindSDL_ttf.cmake b/Modules/FindSDL_ttf.cmake index 6690f5c81b..39c620715e 100644 --- a/Modules/FindSDL_ttf.cmake +++ b/Modules/FindSDL_ttf.cmake @@ -1,6 +1,6 @@ # - Locate SDL_ttf library # This module defines -# SDLTTF_LIBRARY, the name of the library to link against +# SDLTTF_LIBRARY, the library to link against # SDLTTF_FOUND, if false, do not try to link to SDL # SDLTTF_INCLUDE_DIR, where to find SDL/SDL.h # diff --git a/Modules/FindTCL.cmake b/Modules/FindTCL.cmake index 166c74099b..a0d5fb05eb 100644 --- a/Modules/FindTCL.cmake +++ b/Modules/FindTCL.cmake @@ -2,19 +2,19 @@ # This module finds if TCL is installed and determines where the # include files and libraries are. It also determines what the name of # the library is. This code sets the following variables: -# TCL_LIBRARY = path to Tcl library (tcl tcl80) -# TCL_LIBRARY_DEBUG = path to Tcl library (debug) -# TCL_STUB_LIBRARY = path to Tcl stub library -# TCL_STUB_LIBRARY_DEBUG = path to Tcl stub library (debug) -# TCL_INCLUDE_PATH = path to where tcl.h can be found -# TCL_TCLSH = path to tclsh binary (tcl tcl80) -# TK_LIBRARY = path to Tk library (tk tk80 etc) -# TK_LIBRARY_DEBUG = path to Tk library (debug) -# TK_STUB_LIBRARY = path to Tk stub library -# TK_STUB_LIBRARY_DEBUG = path to Tk stub library (debug) -# TK_INCLUDE_PATH = path to where tk.h can be found -# TK_INTERNAL_PATH = path to where tkWinInt.h can be found -# TK_WISH = full path to the wish (wish wish80) +# TCL_LIBRARY = path to Tcl library (tcl tcl80) +# TCL_LIBRARY_DEBUG = path to Tcl library (debug) +# TCL_STUB_LIBRARY = path to Tcl stub library +# TCL_STUB_LIBRARY_DEBUG = path to debug stub library +# TCL_INCLUDE_PATH = path to where tcl.h can be found +# TCL_TCLSH = path to tclsh binary (tcl tcl80) +# TK_LIBRARY = path to Tk library (tk tk80 etc) +# TK_LIBRARY_DEBUG = path to Tk library (debug) +# TK_STUB_LIBRARY = path to Tk stub library +# TK_STUB_LIBRARY_DEBUG = path to debug Tk stub library +# TK_INCLUDE_PATH = path to where tk.h can be found +# TK_INTERNAL_PATH = path to where tkWinInt.h is found +# TK_WISH = full path to the wish executable INCLUDE(CMakeFindFrameworks) INCLUDE(FindTclsh) diff --git a/Modules/FindTIFF.cmake b/Modules/FindTIFF.cmake index 90d0b78d0c..00677562d5 100644 --- a/Modules/FindTIFF.cmake +++ b/Modules/FindTIFF.cmake @@ -1,9 +1,8 @@ # - Find TIFF library # Find the native TIFF includes and library -# # This module defines # TIFF_INCLUDE_DIR, where to find tiff.h, etc. -# TIFF_LIBRARIES, the libraries to link against to use TIFF. +# TIFF_LIBRARIES, libraries to link against to use TIFF. # TIFF_FOUND, If false, do not try to use TIFF. # also defined, but not for general use are # TIFF_LIBRARY, where to find the TIFF library. diff --git a/Modules/FindTclsh.cmake b/Modules/FindTclsh.cmake index f75a6f2111..db8630145d 100644 --- a/Modules/FindTclsh.cmake +++ b/Modules/FindTclsh.cmake @@ -2,7 +2,7 @@ # This module finds if TCL is installed and determines where the # include files and libraries are. It also determines what the name of # the library is. This code sets the following variables: -# TCL_TCLSH = the full path to the tclsh binary (tcl tcl80 etc) +# TCL_TCLSH = the path to the tclsh executable # In cygwin, look for the cygwin version first. Don't look for it later to # avoid finding the cygwin version on a Win32 build. IF(WIN32) diff --git a/Modules/FindThreads.cmake b/Modules/FindThreads.cmake index 95e5aa8519..9a254e92d4 100644 --- a/Modules/FindThreads.cmake +++ b/Modules/FindThreads.cmake @@ -1,10 +1,10 @@ # - This module determines the thread library of the system. # The following variables are set -# CMAKE_THREAD_LIBS_INIT - the thread library (-lpthread ) -# CMAKE_USE_SPROC_INIT - are we using sproc? -# CMAKE_USE_WIN32_THREADS_INIT - are we using WIN32 threads -# CMAKE_USE_PTHREADS_INIT - are we using pthreads -# CMAKE_HP_PTHREADS_INIT - are we using hp pthreads +# CMAKE_THREAD_LIBS_INIT - the thread library +# CMAKE_USE_SPROC_INIT - are we using sproc? +# CMAKE_USE_WIN32_THREADS_INIT - using WIN32 threads? +# CMAKE_USE_PTHREADS_INIT - are we using pthreads +# CMAKE_HP_PTHREADS_INIT - are we using hp pthreads INCLUDE (CheckIncludeFile) INCLUDE (CheckIncludeFiles) diff --git a/Modules/FindVTK.cmake b/Modules/FindVTK.cmake index 23789e4c8b..eca57d64ca 100644 --- a/Modules/FindVTK.cmake +++ b/Modules/FindVTK.cmake @@ -1,26 +1,30 @@ # - Find a VTK installation or build tree. # The following variables are set if VTK is found. If VTK is not # found, VTK_FOUND is set to false. -# VTK_FOUND - Set to true when VTK is found. -# VTK_USE_FILE - CMake file to setup a project to use VTK. -# VTK_MAJOR_VERSION - The VTK major version number. -# VTK_MINOR_VERSION - The VTK minor version number +# VTK_FOUND - Set to true when VTK is found. +# VTK_USE_FILE - CMake file to use VTK. +# VTK_MAJOR_VERSION - The VTK major version number. +# VTK_MINOR_VERSION - The VTK minor version number # (odd non-release). -# VTK_BUILD_VERSION - The VTK patch level +# VTK_BUILD_VERSION - The VTK patch level # (meaningless for odd minor). -# VTK_INCLUDE_DIRS - Include directories for VTK headers. -# VTK_LIBRARY_DIRS - Link directories for VTK libraries. -# VTK_KITS - List of VTK kits, in CAPS (COMMON,IO,). -# VTK_LANGUAGES - List of wrapped languages, in CAPS (TCL,) +# VTK_INCLUDE_DIRS - Include directories for VTK +# VTK_LIBRARY_DIRS - Link directories for VTK libraries +# VTK_KITS - List of VTK kits, in CAPS +# (COMMON,IO,) etc. +# VTK_LANGUAGES - List of wrapped languages, in CAPS +# (TCL, PYHTON,) etc. # The following cache entries must be set by the user to locate VTK: -# VTK_DIR - The directory containing VTKConfig.cmake. This -# is either the root of the build tree, or the -# lib/vtk directory. This is the only cache entry. +# VTK_DIR - The directory containing VTKConfig.cmake. +# This is either the root of the build tree, +# or the lib/vtk directory. This is the +# only cache entry. # The following variables are set for backward compatibility and # should not be used in new code: -# USE_VTK_FILE - The full path to the UseVTK.cmake file. This -# is provided for backward compatability. Use -# VTK_USE_FILE instead. +# USE_VTK_FILE - The full path to the UseVTK.cmake file. +# This is provided for backward +# compatibility. Use VTK_USE_FILE +# instead. # # Construct consitent error messages for use below. diff --git a/Modules/FindWget.cmake b/Modules/FindWget.cmake index f6804b9389..9c9e257937 100644 --- a/Modules/FindWget.cmake +++ b/Modules/FindWget.cmake @@ -1,8 +1,7 @@ # - Find wget -# This module looks for wget. -# -# This module defines the following values: -# WGET_EXECUTABLE: This variable defines the full path to the wget tool. +# This module looks for wget. This module defines the +# following values: +# WGET_EXECUTABLE: the full path to the wget tool. # WGET_FOUND: True if wget has been found. INCLUDE(FindCygwin) diff --git a/Modules/FindWish.cmake b/Modules/FindWish.cmake index 5f62c6491b..ea4894015e 100644 --- a/Modules/FindWish.cmake +++ b/Modules/FindWish.cmake @@ -3,9 +3,9 @@ # include files and libraries are. It also determines what the name of # the library is. This code sets the following variables: # -# TK_WISH = the full path to the wish binary (wish wish80 etc) +# TK_WISH = the path to the wish executable # -# if UNIX is defined, then look for the cygwin version first +# if UNIX is defined, then it will look for the cygwin version first IF(UNIX) FIND_PROGRAM(TK_WISH cygwish80 ) ENDIF(UNIX) diff --git a/Modules/FindX11.cmake b/Modules/FindX11.cmake index acf174f26f..25d6e1e420 100644 --- a/Modules/FindX11.cmake +++ b/Modules/FindX11.cmake @@ -1,10 +1,8 @@ # - Find X11 installation -# Try to find X11 on UNIX systems. -# -# The following values are defined -# X11_FOUND - True if X11 is available +# Try to find X11 on UNIX systems. The following values are defined +# X11_FOUND - True if X11 is available # X11_INCLUDE_DIR - include directories to use X11 -# X11_LIBRARIES - link against these to use X11 +# X11_LIBRARIES - link against these to use X11 IF (UNIX) SET(X11_FOUND 0) diff --git a/Modules/FindwxWindows.cmake b/Modules/FindwxWindows.cmake index dd3657a253..a7352a8927 100644 --- a/Modules/FindwxWindows.cmake +++ b/Modules/FindwxWindows.cmake @@ -3,15 +3,15 @@ # include files and libraries are. It also determines what the name of # the library is. This code sets the following variables: # -# WXWINDOWS_FOUND = system has WxWindows -# WXWINDOWS_LIBRARIES = full path to the wxWindows libraries -# on Unix/Linux with additional linker -# flags from "wx-config --libs" -# CMAKE_WXWINDOWS_CXX_FLAGS = Compiler flags for wxWindows, -# essentially +# WXWINDOWS_FOUND = system has WxWindows +# WXWINDOWS_LIBRARIES = path to the wxWindows libraries +# on Unix/Linux with additional +# linker flags from +# "wx-config --libs" +# CMAKE_WXWINDOWS_CXX_FLAGS = Compiler flags for +# wxWindows, essentially # "`wx-config --cxxflags`" -# WXWINDOWS_INCLUDE_DIR = where to find "wx/wx.h" -# "wx/setup.h" +# WXWINDOWS_INCLUDE_DIR = where to find "wx/wx.h" etc # WXWINDOWS_LINK_DIRECTORIES = link directories # WXWINDOWS_DEFINITIONS = extra defines # deprecated: @@ -20,18 +20,10 @@ # * CMAKE_WX_CXX_FLAGS # * WXWINDOWS_INCLUDE_PATH # -# USAGE: -# for convenience include Use_wxWindows.cmake in your projects -# CMakeLists.txt: -# -# if you need OpenGL support please -# SET(WXWINDOWS_USE_GL 1) -# # in your CMakeLists.txt *before* you include this file. -# -# # just include Use_wxWindows.cmake -# # in your projects CMakeLists.txt -# INCLUDE(Use_wxWindows) -# +# For convenience include Use_wxWindows.cmake in your project's +# CMakeLists.txt using INCLUDE(Use_wxWindows). If you need OpenGL support +# please SET(WXWINDOWS_USE_GL 1) in your CMakeLists.txt *before* you include +# this file. # ------------------------------------------------------------------ diff --git a/Modules/TestForANSIStreamHeaders.cmake b/Modules/TestForANSIStreamHeaders.cmake index b5e669d562..e3d4483b27 100644 --- a/Modules/TestForANSIStreamHeaders.cmake +++ b/Modules/TestForANSIStreamHeaders.cmake @@ -1,6 +1,6 @@ # - Test for compiler support of ANSI stream headers iostream, etc. # check if we they have the standard ansi stream files (without the .h) -# CMAKE_NO_ANSI_STREAM_HEADERS - defined according to the results +# CMAKE_NO_ANSI_STREAM_HEADERS - defined by the results # INCLUDE(CheckIncludeFileCXX) diff --git a/Modules/TestForSTDNamespace.cmake b/Modules/TestForSTDNamespace.cmake index 20bdaa1f1c..e0991efe3d 100644 --- a/Modules/TestForSTDNamespace.cmake +++ b/Modules/TestForSTDNamespace.cmake @@ -1,6 +1,6 @@ # - Test for std:: namespace support # check if the compiler supports std:: on stl classes -# CMAKE_NO_STD_NAMESPACE - defined according to the results +# CMAKE_NO_STD_NAMESPACE - defined by the results # IF("CMAKE_STD_NAMESPACE" MATCHES "^CMAKE_STD_NAMESPACE$") MESSAGE(STATUS "Check for STD namespace") diff --git a/Modules/UseSWIG.cmake b/Modules/UseSWIG.cmake index db313b57c9..b107d6c8bb 100644 --- a/Modules/UseSWIG.cmake +++ b/Modules/UseSWIG.cmake @@ -7,7 +7,7 @@ # All other macros are for internal use only. # To get the actual name of the swig module, # use: ${SWIG_MODULE_name_REAL_NAME}. -# Set Source files propertis such as CPLUSPLUS and SWIG_FLAGS to specify +# Set Source files properties such as CPLUSPLUS and SWIG_FLAGS to specify # special behavior of SWIG. Also global CMAKE_SWIG_FLAGS can be used to add # special flags to all swig calls. # Another special variable is CMAKE_SWIG_OUTDIR, it allows one to specify diff --git a/Modules/Use_wxWindows.cmake b/Modules/Use_wxWindows.cmake index e41819c86c..8acd0a135f 100644 --- a/Modules/Use_wxWindows.cmake +++ b/Modules/Use_wxWindows.cmake @@ -4,7 +4,6 @@ # and set the appropriate libs, incdirs, flags etc. # INCLUDE_DIRECTORIES, LINK_DIRECTORIES and ADD_DEFINITIONS # are called. -# # author Jan Woetzel <jw -at- mip.informatik.uni-kiel.de> (07/2003) # # if you are sure you need GL then |