kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
CMake/Utilities/CMakeLists.txt

158 lines
6.7 KiB
CMake
Raw Normal View History

Convert CMake to OSI-approved BSD License This converts the CMake license to a pure 3-clause OSI-approved BSD License. We drop the previous license clause requiring modified versions to be plainly marked. We also update the CMake copyright to cover the full development time range.
2009-09-28 19:43:28 +04:00
#=============================================================================
# CMake - Cross Platform Makefile Generator
# Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
#
# Distributed under the OSI-approved BSD License (the "License");
# see accompanying file Copyright.txt for details.
#
# This software is distributed WITHOUT ANY WARRANTY; without even the
# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
# See the License for more information.
#=============================================================================
Convert CMake-language commands to lower case Ancient CMake versions required upper-case commands. Later command names became case-insensitive. Now the preferred style is lower-case. Run the following shell code: cmake --help-command-list | grep -v "cmake version" | while read c; do echo 's/\b'"$(echo $c | tr '[:lower:]' '[:upper:]')"'\(\s*\)(/'"$c"'\1(/g' done >convert.sed && git ls-files -z -- bootstrap '*.cmake' '*.cmake.in' '*CMakeLists.txt' | egrep -z -v '^(Utilities/cm|Source/kwsys/)' | xargs -0 sed -i -f convert.sed && rm convert.sed
2012-08-13 21:47:32 +04:00
subdirs(Doxygen KWStyle)
ENH: Added optional configuration of data/doc/man dirs. This will be useful for package maintainers.
2003-07-22 00:38:53 +04:00
Convert CMake-language commands to lower case Ancient CMake versions required upper-case commands. Later command names became case-insensitive. Now the preferred style is lower-case. Run the following shell code: cmake --help-command-list | grep -v "cmake version" | while read c; do echo 's/\b'"$(echo $c | tr '[:lower:]' '[:upper:]')"'\(\s*\)(/'"$c"'\1(/g' done >convert.sed && git ls-files -z -- bootstrap '*.cmake' '*.cmake.in' '*CMakeLists.txt' | egrep -z -v '^(Utilities/cm|Source/kwsys/)' | xargs -0 sed -i -f convert.sed && rm convert.sed
2012-08-13 21:47:32 +04:00
make_directory(${CMake_BINARY_DIR}/Docs)
ENH: Added generation of ccmake documentation on UNIX.
2003-07-22 01:14:16 +04:00
# Add a documentation target.
Convert CMake-language commands to lower case Ancient CMake versions required upper-case commands. Later command names became case-insensitive. Now the preferred style is lower-case. Run the following shell code: cmake --help-command-list | grep -v "cmake version" | while read c; do echo 's/\b'"$(echo $c | tr '[:lower:]' '[:upper:]')"'\(\s*\)(/'"$c"'\1(/g' done >convert.sed && git ls-files -z -- bootstrap '*.cmake' '*.cmake.in' '*CMakeLists.txt' | egrep -z -v '^(Utilities/cm|Source/kwsys/)' | xargs -0 sed -i -f convert.sed && rm convert.sed
2012-08-13 21:47:32 +04:00
set(DOC_FILES "")
ENH: Added generation of ccmake documentation on UNIX.
2003-07-22 01:14:16 +04:00
Convert CMake-language commands to lower case Ancient CMake versions required upper-case commands. Later command names became case-insensitive. Now the preferred style is lower-case. Run the following shell code: cmake --help-command-list | grep -v "cmake version" | while read c; do echo 's/\b'"$(echo $c | tr '[:lower:]' '[:upper:]')"'\(\s*\)(/'"$c"'\1(/g' done >convert.sed && git ls-files -z -- bootstrap '*.cmake' '*.cmake.in' '*CMakeLists.txt' | egrep -z -v '^(Utilities/cm|Source/kwsys/)' | xargs -0 sed -i -f convert.sed && rm convert.sed
2012-08-13 21:47:32 +04:00
set(MAN_FILES
Documentation: Cleanup installation rules Organize Utilities/CMakeLists.txt to avoid duplicate install command calls. We collect each type of documentation in a variable listing its files for installation and then use one install call at the end.
2010-03-01 16:43:54 +03:00
${CMake_BINARY_DIR}/Docs/cmake.1
${CMake_BINARY_DIR}/Docs/cmakecommands.1
${CMake_BINARY_DIR}/Docs/cmakecompat.1
${CMake_BINARY_DIR}/Docs/cmakeprops.1
${CMake_BINARY_DIR}/Docs/cmakepolicies.1
${CMake_BINARY_DIR}/Docs/cmakevars.1
${CMake_BINARY_DIR}/Docs/cmakemodules.1
)
Convert CMake-language commands to lower case Ancient CMake versions required upper-case commands. Later command names became case-insensitive. Now the preferred style is lower-case. Run the following shell code: cmake --help-command-list | grep -v "cmake version" | while read c; do echo 's/\b'"$(echo $c | tr '[:lower:]' '[:upper:]')"'\(\s*\)(/'"$c"'\1(/g' done >convert.sed && git ls-files -z -- bootstrap '*.cmake' '*.cmake.in' '*CMakeLists.txt' | egrep -z -v '^(Utilities/cm|Source/kwsys/)' | xargs -0 sed -i -f convert.sed && rm convert.sed
2012-08-13 21:47:32 +04:00
set(TEXT_FILES
Documentation: Cleanup installation rules Organize Utilities/CMakeLists.txt to avoid duplicate install command calls. We collect each type of documentation in a variable listing its files for installation and then use one install call at the end.
2010-03-01 16:43:54 +03:00
${CMake_BINARY_DIR}/Docs/cmake.txt
${CMake_BINARY_DIR}/Docs/cmake.docbook
${CMake_BINARY_DIR}/Docs/cmake-policies.txt
${CMake_BINARY_DIR}/Docs/cmake-properties.txt
${CMake_BINARY_DIR}/Docs/cmake-variables.txt
${CMake_BINARY_DIR}/Docs/cmake-modules.txt
${CMake_BINARY_DIR}/Docs/cmake-commands.txt
${CMake_BINARY_DIR}/Docs/cmake-compatcommands.txt
)
Convert CMake-language commands to lower case Ancient CMake versions required upper-case commands. Later command names became case-insensitive. Now the preferred style is lower-case. Run the following shell code: cmake --help-command-list | grep -v "cmake version" | while read c; do echo 's/\b'"$(echo $c | tr '[:lower:]' '[:upper:]')"'\(\s*\)(/'"$c"'\1(/g' done >convert.sed && git ls-files -z -- bootstrap '*.cmake' '*.cmake.in' '*CMakeLists.txt' | egrep -z -v '^(Utilities/cm|Source/kwsys/)' | xargs -0 sed -i -f convert.sed && rm convert.sed
2012-08-13 21:47:32 +04:00
set(HTML_FILES
Documentation: Cleanup installation rules Organize Utilities/CMakeLists.txt to avoid duplicate install command calls. We collect each type of documentation in a variable listing its files for installation and then use one install call at the end.
2010-03-01 16:43:54 +03:00
${CMake_BINARY_DIR}/Docs/cmake.html
${CMake_BINARY_DIR}/Docs/cmake-policies.html
${CMake_BINARY_DIR}/Docs/cmake-properties.html
${CMake_BINARY_DIR}/Docs/cmake-variables.html
${CMake_BINARY_DIR}/Docs/cmake-modules.html
${CMake_BINARY_DIR}/Docs/cmake-commands.html
${CMake_BINARY_DIR}/Docs/cmake-compatcommands.html
)
Convert CMake-language commands to lower case Ancient CMake versions required upper-case commands. Later command names became case-insensitive. Now the preferred style is lower-case. Run the following shell code: cmake --help-command-list | grep -v "cmake version" | while read c; do echo 's/\b'"$(echo $c | tr '[:lower:]' '[:upper:]')"'\(\s*\)(/'"$c"'\1(/g' done >convert.sed && git ls-files -z -- bootstrap '*.cmake' '*.cmake.in' '*CMakeLists.txt' | egrep -z -v '^(Utilities/cm|Source/kwsys/)' | xargs -0 sed -i -f convert.sed && rm convert.sed
2012-08-13 21:47:32 +04:00
macro(ADD_DOCS target dependency)
STYLE: use a macro for generating the documentation Alex
2007-06-15 16:53:33 +04:00
# Generate documentation for "ctest" executable.
Convert CMake-language commands to lower case Ancient CMake versions required upper-case commands. Later command names became case-insensitive. Now the preferred style is lower-case. Run the following shell code: cmake --help-command-list | grep -v "cmake version" | while read c; do echo 's/\b'"$(echo $c | tr '[:lower:]' '[:upper:]')"'\(\s*\)(/'"$c"'\1(/g' done >convert.sed && git ls-files -z -- bootstrap '*.cmake' '*.cmake.in' '*CMakeLists.txt' | egrep -z -v '^(Utilities/cm|Source/kwsys/)' | xargs -0 sed -i -f convert.sed && rm convert.sed
2012-08-13 21:47:32 +04:00
get_target_property(CMD ${target} LOCATION)
STYLE: use a macro for generating the documentation Alex
2007-06-15 16:53:33 +04:00
# only generate the documentation if the target is actually built
Convert CMake-language commands to lower case Ancient CMake versions required upper-case commands. Later command names became case-insensitive. Now the preferred style is lower-case. Run the following shell code: cmake --help-command-list | grep -v "cmake version" | while read c; do echo 's/\b'"$(echo $c | tr '[:lower:]' '[:upper:]')"'\(\s*\)(/'"$c"'\1(/g' done >convert.sed && git ls-files -z -- bootstrap '*.cmake' '*.cmake.in' '*CMakeLists.txt' | egrep -z -v '^(Utilities/cm|Source/kwsys/)' | xargs -0 sed -i -f convert.sed && rm convert.sed
2012-08-13 21:47:32 +04:00
if(CMD)
add_custom_command(
STYLE: use a macro for generating the documentation Alex
2007-06-15 16:53:33 +04:00
OUTPUT ${CMake_BINARY_DIR}/Docs/${target}.txt
ENH: Help cmake-gui docs generation on Windows We use a custom command to run 'cmake-gui --help...' to generate the documentation for the application. Since this is a Qt application, the executable must find the Qt DLLs in order to run. As a convenience, if QtCore4.dll appears next to qmake.exe, we put its location in the PATH environment variable when running the custom command on Windows.
2009-02-24 17:00:42 +03:00
${${target}-PATH} # Possibly set PATH, see below.
STYLE: use a macro for generating the documentation Alex
2007-06-15 16:53:33 +04:00
COMMAND ${CMD}
ARGS --help-full ${CMake_BINARY_DIR}/Docs/${target}.txt
ENH: -in the full documentation there is now an extra section for compatibility commands, so users see which commands they shouldn't use -cmake -h <command> now also works with lower case commands --help-fullm --help-command, --help-module and --help-property now determine the output format from the extension of the given filename Let me know if there are some things I overlooked. Alex
2007-06-28 19:00:57 +04:00
--help-full ${CMake_BINARY_DIR}/Docs/${target}.html
--help-full ${CMake_BINARY_DIR}/Docs/${target}.1
STYLE: add "--help-policy" and "--help-policies" to the documentation -generate and install the policy documentation files -generate and install the docbook files for cmake, ctest, cpack, ccmake (cmake-gui not yet ?) Alex
2008-05-13 23:43:00 +04:00
--help-full ${CMake_BINARY_DIR}/Docs/${target}.docbook
STYLE: use a macro for generating the documentation Alex
2007-06-15 16:53:33 +04:00
DEPENDS ${target}
MAIN_DEPENDENCY ${dependency}
)
Convert CMake-language commands to lower case Ancient CMake versions required upper-case commands. Later command names became case-insensitive. Now the preferred style is lower-case. Run the following shell code: cmake --help-command-list | grep -v "cmake version" | while read c; do echo 's/\b'"$(echo $c | tr '[:lower:]' '[:upper:]')"'\(\s*\)(/'"$c"'\1(/g' done >convert.sed && git ls-files -z -- bootstrap '*.cmake' '*.cmake.in' '*CMakeLists.txt' | egrep -z -v '^(Utilities/cm|Source/kwsys/)' | xargs -0 sed -i -f convert.sed && rm convert.sed
2012-08-13 21:47:32 +04:00
set(DOC_FILES ${DOC_FILES} ${CMake_BINARY_DIR}/Docs/${target}.txt)
list(APPEND MAN_FILES ${CMake_BINARY_DIR}/Docs/${target}.1)
list(APPEND TEXT_FILES
STYLE: use a macro for generating the documentation Alex
2007-06-15 16:53:33 +04:00
${CMake_BINARY_DIR}/Docs/${target}.txt
STYLE: add "--help-policy" and "--help-policies" to the documentation -generate and install the policy documentation files -generate and install the docbook files for cmake, ctest, cpack, ccmake (cmake-gui not yet ?) Alex
2008-05-13 23:43:00 +04:00
${CMake_BINARY_DIR}/Docs/${target}.docbook
STYLE: use a macro for generating the documentation Alex
2007-06-15 16:53:33 +04:00
)
Convert CMake-language commands to lower case Ancient CMake versions required upper-case commands. Later command names became case-insensitive. Now the preferred style is lower-case. Run the following shell code: cmake --help-command-list | grep -v "cmake version" | while read c; do echo 's/\b'"$(echo $c | tr '[:lower:]' '[:upper:]')"'\(\s*\)(/'"$c"'\1(/g' done >convert.sed && git ls-files -z -- bootstrap '*.cmake' '*.cmake.in' '*CMakeLists.txt' | egrep -z -v '^(Utilities/cm|Source/kwsys/)' | xargs -0 sed -i -f convert.sed && rm convert.sed
2012-08-13 21:47:32 +04:00
list(APPEND HTML_FILES ${CMake_BINARY_DIR}/Docs/${target}.html)
Remove CMake-language block-end command arguments Ancient versions of CMake required else(), endif(), and similar block termination commands to have arguments matching the command starting the block. This is no longer the preferred style. Run the following shell code: for c in else endif endforeach endfunction endmacro endwhile; do echo 's/\b'"$c"'\(\s*\)(.\+)/'"$c"'\1()/' done >convert.sed && git ls-files -z -- bootstrap '*.cmake' '*.cmake.in' '*CMakeLists.txt' | egrep -z -v '^(Utilities/cm|Source/kwsys/)' | egrep -z -v 'Tests/CMakeTests/While-Endwhile-' | xargs -0 sed -i -f convert.sed && rm convert.sed
2012-08-13 21:50:14 +04:00
endif()
endmacro()
STYLE: use a macro for generating the documentation Alex
2007-06-15 16:53:33 +04:00
ENH: Help cmake-gui docs generation on Windows We use a custom command to run 'cmake-gui --help...' to generate the documentation for the application. Since this is a Qt application, the executable must find the Qt DLLs in order to run. As a convenience, if QtCore4.dll appears next to qmake.exe, we put its location in the PATH environment variable when running the custom command on Windows.
2009-02-24 17:00:42 +03:00
# Help cmake-gui find the Qt DLLs on Windows.
Convert CMake-language commands to lower case Ancient CMake versions required upper-case commands. Later command names became case-insensitive. Now the preferred style is lower-case. Run the following shell code: cmake --help-command-list | grep -v "cmake version" | while read c; do echo 's/\b'"$(echo $c | tr '[:lower:]' '[:upper:]')"'\(\s*\)(/'"$c"'\1(/g' done >convert.sed && git ls-files -z -- bootstrap '*.cmake' '*.cmake.in' '*CMakeLists.txt' | egrep -z -v '^(Utilities/cm|Source/kwsys/)' | xargs -0 sed -i -f convert.sed && rm convert.sed
2012-08-13 21:47:32 +04:00
set(WIN_SHELL_GENS "Visual Studio|NMake|MinGW|Watcom|Borland")
if(BUILD_QtDialog AND "${CMAKE_GENERATOR}" MATCHES "${WIN_SHELL_GENS}"
BUG: Fix cmake-gui docs generation PATH feature Automatic addition of the Qt DLL location to PATH can be done only for generators that use a Windows shell.
2009-02-25 01:07:04 +03:00
AND EXISTS "${QT_QMAKE_EXECUTABLE}" AND NOT CMAKE_NO_AUTO_QT_ENV)
Convert CMake-language commands to lower case Ancient CMake versions required upper-case commands. Later command names became case-insensitive. Now the preferred style is lower-case. Run the following shell code: cmake --help-command-list | grep -v "cmake version" | while read c; do echo 's/\b'"$(echo $c | tr '[:lower:]' '[:upper:]')"'\(\s*\)(/'"$c"'\1(/g' done >convert.sed && git ls-files -z -- bootstrap '*.cmake' '*.cmake.in' '*CMakeLists.txt' | egrep -z -v '^(Utilities/cm|Source/kwsys/)' | xargs -0 sed -i -f convert.sed && rm convert.sed
2012-08-13 21:47:32 +04:00
get_filename_component(Qt_BIN_DIR "${QT_QMAKE_EXECUTABLE}" PATH)
if(EXISTS "${Qt_BIN_DIR}/QtCore4.dll")
ENH: Help cmake-gui docs generation on Windows We use a custom command to run 'cmake-gui --help...' to generate the documentation for the application. Since this is a Qt application, the executable must find the Qt DLLs in order to run. As a convenience, if QtCore4.dll appears next to qmake.exe, we put its location in the PATH environment variable when running the custom command on Windows.
2009-02-24 17:00:42 +03:00
# Tell the macro to set the path before running cmake-gui.
Convert CMake-language commands to lower case Ancient CMake versions required upper-case commands. Later command names became case-insensitive. Now the preferred style is lower-case. Run the following shell code: cmake --help-command-list | grep -v "cmake version" | while read c; do echo 's/\b'"$(echo $c | tr '[:lower:]' '[:upper:]')"'\(\s*\)(/'"$c"'\1(/g' done >convert.sed && git ls-files -z -- bootstrap '*.cmake' '*.cmake.in' '*CMakeLists.txt' | egrep -z -v '^(Utilities/cm|Source/kwsys/)' | xargs -0 sed -i -f convert.sed && rm convert.sed
2012-08-13 21:47:32 +04:00
string(REPLACE ";" "\\;" _PATH "PATH=${Qt_BIN_DIR};%PATH%")
set(cmake-gui-PATH COMMAND set "${_PATH}")
Remove CMake-language block-end command arguments Ancient versions of CMake required else(), endif(), and similar block termination commands to have arguments matching the command starting the block. This is no longer the preferred style. Run the following shell code: for c in else endif endforeach endfunction endmacro endwhile; do echo 's/\b'"$c"'\(\s*\)(.\+)/'"$c"'\1()/' done >convert.sed && git ls-files -z -- bootstrap '*.cmake' '*.cmake.in' '*CMakeLists.txt' | egrep -z -v '^(Utilities/cm|Source/kwsys/)' | egrep -z -v 'Tests/CMakeTests/While-Endwhile-' | xargs -0 sed -i -f convert.sed && rm convert.sed
2012-08-13 21:50:14 +04:00
endif()
Remove CMake multiline block-end command arguments removing arguments omitted in 9db3116226cb99fcf54e936c833953abcde9b729
2012-08-15 19:59:36 +04:00
endif()
ENH: Help cmake-gui docs generation on Windows We use a custom command to run 'cmake-gui --help...' to generate the documentation for the application. Since this is a Qt application, the executable must find the Qt DLLs in order to run. As a convenience, if QtCore4.dll appears next to qmake.exe, we put its location in the PATH environment variable when running the custom command on Windows.
2009-02-24 17:00:42 +03:00
STYLE: use a macro for generating the documentation Alex
2007-06-15 16:53:33 +04:00
# add the docs for the executables
ADD_DOCS(ctest ${CMake_SOURCE_DIR}/Utilities/Doxygen/authors.txt)
ADD_DOCS(cpack ${CMake_SOURCE_DIR}/Utilities/Doxygen/authors.txt)
ADD_DOCS(ccmake ${CMake_SOURCE_DIR}/Utilities/Doxygen/authors.txt)
ADD_DOCS(CMakeSetup ${CMake_SOURCE_DIR}/Utilities/Doxygen/doxyfile.in)
ENH: add cmake gui docs
2009-02-14 05:51:46 +03:00
ADD_DOCS(cmake-gui ${CMake_SOURCE_DIR}/Utilities/Doxygen/doxyfile.in)
STYLE: use a macro for generating the documentation Alex
2007-06-15 16:53:33 +04:00
ENH: generate separate documentation for the commands, compatiblity commands, modules and properties as html, text and man pages. The names of the man pages are cmcommands, cmcompat, cmprops and cmmodules, so they are easy to type. Alex
2007-06-28 23:04:28 +04:00
# add the documentation for cmake itself
Convert CMake-language commands to lower case Ancient CMake versions required upper-case commands. Later command names became case-insensitive. Now the preferred style is lower-case. Run the following shell code: cmake --help-command-list | grep -v "cmake version" | while read c; do echo 's/\b'"$(echo $c | tr '[:lower:]' '[:upper:]')"'\(\s*\)(/'"$c"'\1(/g' done >convert.sed && git ls-files -z -- bootstrap '*.cmake' '*.cmake.in' '*CMakeLists.txt' | egrep -z -v '^(Utilities/cm|Source/kwsys/)' | xargs -0 sed -i -f convert.sed && rm convert.sed
2012-08-13 21:47:32 +04:00
get_target_property(CMD cmake LOCATION)
add_custom_command(
BUG: fix build with cmake < 2.4 Alex
2007-07-02 19:05:43 +04:00
OUTPUT ${CMake_BINARY_DIR}/Docs/cmake.txt
Remove trailing whitespace from most CMake and C/C++ code Our Git commit hooks disallow modification or addition of lines with trailing whitespace. Wipe out all remnants of trailing whitespace everywhere except third-party code. Run the following shell code: git ls-files -z -- \ bootstrap doxygen.config '*.readme' \ '*.c' '*.cmake' '*.cpp' '*.cxx' \ '*.el' '*.f' '*.f90' '*.h' '*.in' '*.in.l' '*.java' \ '*.mm' '*.pike' '*.py' '*.txt' '*.vim' | egrep -z -v '^(Utilities/cm|Source/(kwsys|CursesDialog/form)/)' | egrep -z -v '^(Modules/CPack\..*\.in)' | xargs -0 sed -i 's/ \+$//'
2012-08-13 21:42:58 +04:00
COMMAND ${CMD}
BUG: fix build with cmake < 2.4 Alex
2007-07-02 19:05:43 +04:00
ARGS --copyright ${CMake_BINARY_DIR}/Docs/Copyright.txt
ENH: generate separate documentation for the commands, compatiblity commands, modules and properties as html, text and man pages. The names of the man pages are cmcommands, cmcompat, cmprops and cmmodules, so they are easy to type. Alex
2007-06-28 23:04:28 +04:00
--help-full ${CMake_BINARY_DIR}/Docs/cmake.txt
--help-full ${CMake_BINARY_DIR}/Docs/cmake.html
--help-full ${CMake_BINARY_DIR}/Docs/cmake.1
STYLE: add "--help-policy" and "--help-policies" to the documentation -generate and install the policy documentation files -generate and install the docbook files for cmake, ctest, cpack, ccmake (cmake-gui not yet ?) Alex
2008-05-13 23:43:00 +04:00
--help-full ${CMake_BINARY_DIR}/Docs/cmake.docbook
--help-policies ${CMake_BINARY_DIR}/Docs/cmake-policies.txt
--help-policies ${CMake_BINARY_DIR}/Docs/cmake-policies.html
--help-policies ${CMake_BINARY_DIR}/Docs/cmakepolicies.1
ENH: generate separate documentation for the commands, compatiblity commands, modules and properties as html, text and man pages. The names of the man pages are cmcommands, cmcompat, cmprops and cmmodules, so they are easy to type. Alex
2007-06-28 23:04:28 +04:00
--help-properties ${CMake_BINARY_DIR}/Docs/cmake-properties.txt
--help-properties ${CMake_BINARY_DIR}/Docs/cmake-properties.html
STYLE: better error message, name the new manpages cmakecommands, cmakecompat, cmakeprops and cmakemodules Alex
2007-07-13 20:03:13 +04:00
--help-properties ${CMake_BINARY_DIR}/Docs/cmakeprops.1
ENH: some more cleanup, fixes, and patch for HTML output
2007-10-24 19:36:47 +04:00
--help-variables ${CMake_BINARY_DIR}/Docs/cmake-variables.txt
--help-variables ${CMake_BINARY_DIR}/Docs/cmake-variables.html
--help-variables ${CMake_BINARY_DIR}/Docs/cmakevars.1
ENH: generate separate documentation for the commands, compatiblity commands, modules and properties as html, text and man pages. The names of the man pages are cmcommands, cmcompat, cmprops and cmmodules, so they are easy to type. Alex
2007-06-28 23:04:28 +04:00
--help-modules ${CMake_BINARY_DIR}/Docs/cmake-modules.txt
--help-modules ${CMake_BINARY_DIR}/Docs/cmake-modules.html
STYLE: better error message, name the new manpages cmakecommands, cmakecompat, cmakeprops and cmakemodules Alex
2007-07-13 20:03:13 +04:00
--help-modules ${CMake_BINARY_DIR}/Docs/cmakemodules.1
ENH: generate separate documentation for the commands, compatiblity commands, modules and properties as html, text and man pages. The names of the man pages are cmcommands, cmcompat, cmprops and cmmodules, so they are easy to type. Alex
2007-06-28 23:04:28 +04:00
--help-commands ${CMake_BINARY_DIR}/Docs/cmake-commands.txt
--help-commands ${CMake_BINARY_DIR}/Docs/cmake-commands.html
STYLE: better error message, name the new manpages cmakecommands, cmakecompat, cmakeprops and cmakemodules Alex
2007-07-13 20:03:13 +04:00
--help-commands ${CMake_BINARY_DIR}/Docs/cmakecommands.1
ENH: generate separate documentation for the commands, compatiblity commands, modules and properties as html, text and man pages. The names of the man pages are cmcommands, cmcompat, cmprops and cmmodules, so they are easy to type. Alex
2007-06-28 23:04:28 +04:00
--help-compatcommands ${CMake_BINARY_DIR}/Docs/cmake-compatcommands.txt
--help-compatcommands ${CMake_BINARY_DIR}/Docs/cmake-compatcommands.html
STYLE: better error message, name the new manpages cmakecommands, cmakecompat, cmakeprops and cmakemodules Alex
2007-07-13 20:03:13 +04:00
--help-compatcommands ${CMake_BINARY_DIR}/Docs/cmakecompat.1
BUG: the cmake deps depend on cmake Alex
2007-07-06 21:08:20 +04:00
DEPENDS cmake
BUG: converted to 1.8 form of custom commands
2005-07-15 20:01:20 +04:00
MAIN_DEPENDENCY ${CMake_SOURCE_DIR}/Utilities/Doxygen/authors.txt
ENH: Added optional configuration of data/doc/man dirs. This will be useful for package maintainers.
2003-07-22 00:38:53 +04:00
)
ENH: generate separate documentation for the commands, compatiblity commands, modules and properties as html, text and man pages. The names of the man pages are cmcommands, cmcompat, cmprops and cmmodules, so they are easy to type. Alex
2007-06-28 23:04:28 +04:00
Convert CMake-language commands to lower case Ancient CMake versions required upper-case commands. Later command names became case-insensitive. Now the preferred style is lower-case. Run the following shell code: cmake --help-command-list | grep -v "cmake version" | while read c; do echo 's/\b'"$(echo $c | tr '[:lower:]' '[:upper:]')"'\(\s*\)(/'"$c"'\1(/g' done >convert.sed && git ls-files -z -- bootstrap '*.cmake' '*.cmake.in' '*CMakeLists.txt' | egrep -z -v '^(Utilities/cm|Source/kwsys/)' | xargs -0 sed -i -f convert.sed && rm convert.sed
2012-08-13 21:47:32 +04:00
install_files(${CMAKE_MAN_DIR}/man1 FILES ${MAN_FILES})
install_files(${CMAKE_DOC_DIR} FILES ${HTML_FILES} ${TEXT_FILES})
install(FILES cmake.m4 DESTINATION share/aclocal)
ENH: Added build of documentation for CMakeSetup.
2003-07-24 01:59:37 +04:00
ENH: Added generation of ccmake documentation on UNIX.
2003-07-22 01:14:16 +04:00
# Drive documentation generation.
Convert CMake-language commands to lower case Ancient CMake versions required upper-case commands. Later command names became case-insensitive. Now the preferred style is lower-case. Run the following shell code: cmake --help-command-list | grep -v "cmake version" | while read c; do echo 's/\b'"$(echo $c | tr '[:lower:]' '[:upper:]')"'\(\s*\)(/'"$c"'\1(/g' done >convert.sed && git ls-files -z -- bootstrap '*.cmake' '*.cmake.in' '*CMakeLists.txt' | egrep -z -v '^(Utilities/cm|Source/kwsys/)' | xargs -0 sed -i -f convert.sed && rm convert.sed
2012-08-13 21:47:32 +04:00
add_custom_target(documentation ALL DEPENDS ${DOC_FILES} ${CMake_BINARY_DIR}/Docs/cmake.txt )
Documentation: Test XHTML compliance Use xmllint to validate our generated HTML documentation. See issue #10338.
2010-03-01 16:47:48 +03:00
# Documentation testing.
if(BUILD_TESTING)
find_package(LibXml2 QUIET)
if(NOT DEFINED LIBXML2_XMLLINT_EXECUTABLE)
find_program(LIBXML2_XMLLINT_EXECUTABLE xmllint)
endif()
mark_as_advanced(LIBXML2_XMLLINT_EXECUTABLE)
if(LIBXML2_XMLLINT_EXECUTABLE)
Run CMake.HTML test with older xmllint (#10857) Old versions of xmllint do not have --nonet or --path options. Fall back to the network-access form in this case.
2010-06-23 15:38:33 +04:00
execute_process(COMMAND ${LIBXML2_XMLLINT_EXECUTABLE} --help
OUTPUT_VARIABLE _help ERROR_VARIABLE _err)
if("${_help}" MATCHES "--path" AND "${_help}" MATCHES "--nonet")
# We provide the XHTML DTD and its dependencies in the 'xml'
# directory so that xmllint can run without network access.
# However, it's --path option accepts a space-separated list of
# paths so it cannot handle spaces in the path to the source tree.
# Therefore we run the tool with the current work directory set to
# the 'xml' directory and use '.' as the path.
add_test(CMake.HTML
${CMAKE_CMAKE_COMMAND} -E chdir ${CMAKE_CURRENT_SOURCE_DIR}/xml
${LIBXML2_XMLLINT_EXECUTABLE} --valid --noout --nonet --path .
${HTML_FILES}
)
endif()
Documentation: Test XHTML compliance Use xmllint to validate our generated HTML documentation. See issue #10338.
2010-03-01 16:47:48 +03:00
endif()
endif()