Utilities/CMakeLists.txt

   1 #=============================================================================
   2 # CMake - Cross Platform Makefile Generator
   3 # Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
   4 #
   5 # Distributed under the OSI-approved BSD License (the "License");
   6 # see accompanying file Copyright.txt for details.
   7 #
   8 # This software is distributed WITHOUT ANY WARRANTY; without even the
   9 # implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  10 # See the License for more information.
  11 #=============================================================================
  12 subdirs(Doxygen KWStyle)
  13
  14 make_directory(${CMake_BINARY_DIR}/Docs)
  15
  16 # Add a documentation target.
  17 set(DOC_FILES "")
  18
  19 set(MAN_FILES
  20   ${CMake_BINARY_DIR}/Docs/cmake.1
  21   ${CMake_BINARY_DIR}/Docs/cmakecommands.1
  22   ${CMake_BINARY_DIR}/Docs/cmakecompat.1
  23   ${CMake_BINARY_DIR}/Docs/cmakeprops.1
  24   ${CMake_BINARY_DIR}/Docs/cmakepolicies.1
  25   ${CMake_BINARY_DIR}/Docs/cmakevars.1
  26   ${CMake_BINARY_DIR}/Docs/cmakemodules.1
  27   )
  28 set(TEXT_FILES
  29   ${CMake_BINARY_DIR}/Docs/cmake.txt
  30   ${CMake_BINARY_DIR}/Docs/cmake-policies.txt
  31   ${CMake_BINARY_DIR}/Docs/cmake-properties.txt
  32   ${CMake_BINARY_DIR}/Docs/cmake-variables.txt
  33   ${CMake_BINARY_DIR}/Docs/cmake-modules.txt
  34   ${CMake_BINARY_DIR}/Docs/cmake-commands.txt
  35   ${CMake_BINARY_DIR}/Docs/cmake-compatcommands.txt
  36   )
  37 set(HTML_FILES
  38   ${CMake_BINARY_DIR}/Docs/cmake.html
  39   ${CMake_BINARY_DIR}/Docs/cmake-policies.html
  40   ${CMake_BINARY_DIR}/Docs/cmake-properties.html
  41   ${CMake_BINARY_DIR}/Docs/cmake-variables.html
  42   ${CMake_BINARY_DIR}/Docs/cmake-modules.html
  43   ${CMake_BINARY_DIR}/Docs/cmake-commands.html
  44   ${CMake_BINARY_DIR}/Docs/cmake-compatcommands.html
  45   )
  46 set(DOCBOOK_FILES
  47   ${CMake_BINARY_DIR}/Docs/cmake.docbook
  48   )
  49
  50 macro(ADD_DOCS target dependency)
  51   # Generate documentation for "ctest" executable.
  52   get_target_property(CMD ${target} LOCATION)
  53   # only generate the documentation if the target is actually built
  54   if(CMD)
  55     add_custom_command(
  56       OUTPUT ${CMake_BINARY_DIR}/Docs/${target}.txt
  57       ${${target}-PATH} # Possibly set PATH, see below.
  58       COMMAND ${CMD}
  59       ARGS --help-full ${CMake_BINARY_DIR}/Docs/${target}.txt
  60            --help-full ${CMake_BINARY_DIR}/Docs/${target}.html
  61            --help-full ${CMake_BINARY_DIR}/Docs/${target}.1
  62            --help-full ${CMake_BINARY_DIR}/Docs/${target}.docbook
  63       DEPENDS ${target}
  64       MAIN_DEPENDENCY ${dependency}
  65       )
  66     set(DOC_FILES ${DOC_FILES} ${CMake_BINARY_DIR}/Docs/${target}.txt)
  67     list(APPEND MAN_FILES ${CMake_BINARY_DIR}/Docs/${target}.1)
  68     list(APPEND TEXT_FILES ${CMake_BINARY_DIR}/Docs/${target}.txt)
  69     list(APPEND HTML_FILES ${CMake_BINARY_DIR}/Docs/${target}.html)
  70     list(APPEND DOCBOOK_FILES ${CMake_BINARY_DIR}/Docs/${target}.docbook)
  71   endif()
  72 endmacro()
  73
  74 # Help cmake-gui find the Qt DLLs on Windows.
  75 if(TARGET cmake-gui)
  76   get_property(Qt_BIN_DIR TARGET cmake-gui PROPERTY Qt_BIN_DIR)
  77   set(WIN_SHELL_GENS "Visual Studio|NMake|MinGW|Watcom|Borland")
  78   if(Qt_BIN_DIR AND "${CMAKE_GENERATOR}" MATCHES "${WIN_SHELL_GENS}"
  79       AND NOT CMAKE_NO_AUTO_QT_ENV)
  80     # Tell the macro to set the path before running cmake-gui.
  81     string(REPLACE ";" "\\;" _PATH "PATH=${Qt_BIN_DIR};%PATH%")
  82     set(cmake-gui-PATH COMMAND set "${_PATH}")
  83   endif()
  84 endif()
  85
  86 # add the docs for the executables
  87 ADD_DOCS(ctest      ${CMake_SOURCE_DIR}/Utilities/Doxygen/authors.txt)
  88 ADD_DOCS(cpack      ${CMake_SOURCE_DIR}/Utilities/Doxygen/authors.txt)
  89 ADD_DOCS(ccmake     ${CMake_SOURCE_DIR}/Utilities/Doxygen/authors.txt)
  90 ADD_DOCS(CMakeSetup ${CMake_SOURCE_DIR}/Utilities/Doxygen/doxyfile.in)
  91 ADD_DOCS(cmake-gui ${CMake_SOURCE_DIR}/Utilities/Doxygen/doxyfile.in)
  92
  93 # add the documentation for cmake itself
  94
  95 get_target_property(CMD cmake LOCATION)
  96 add_custom_command(
  97   OUTPUT ${CMake_BINARY_DIR}/Docs/cmake.txt
  98   COMMAND ${CMD}
  99   ARGS --copyright ${CMake_BINARY_DIR}/Docs/Copyright.txt
 100        --help-full ${CMake_BINARY_DIR}/Docs/cmake.txt
 101        --help-full ${CMake_BINARY_DIR}/Docs/cmake.html
 102        --help-full ${CMake_BINARY_DIR}/Docs/cmake.1
 103        --help-full ${CMake_BINARY_DIR}/Docs/cmake.docbook
 104        --help-policies ${CMake_BINARY_DIR}/Docs/cmake-policies.txt
 105        --help-policies ${CMake_BINARY_DIR}/Docs/cmake-policies.html
 106        --help-policies ${CMake_BINARY_DIR}/Docs/cmakepolicies.1
 107        --help-properties ${CMake_BINARY_DIR}/Docs/cmake-properties.txt
 108        --help-properties ${CMake_BINARY_DIR}/Docs/cmake-properties.html
 109        --help-properties ${CMake_BINARY_DIR}/Docs/cmakeprops.1
 110        --help-variables ${CMake_BINARY_DIR}/Docs/cmake-variables.txt
 111        --help-variables ${CMake_BINARY_DIR}/Docs/cmake-variables.html
 112        --help-variables ${CMake_BINARY_DIR}/Docs/cmakevars.1
 113        --help-modules ${CMake_BINARY_DIR}/Docs/cmake-modules.txt
 114        --help-modules ${CMake_BINARY_DIR}/Docs/cmake-modules.html
 115        --help-modules ${CMake_BINARY_DIR}/Docs/cmakemodules.1
 116        --help-commands ${CMake_BINARY_DIR}/Docs/cmake-commands.txt
 117        --help-commands ${CMake_BINARY_DIR}/Docs/cmake-commands.html
 118        --help-commands ${CMake_BINARY_DIR}/Docs/cmakecommands.1
 119        --help-compatcommands ${CMake_BINARY_DIR}/Docs/cmake-compatcommands.txt
 120        --help-compatcommands ${CMake_BINARY_DIR}/Docs/cmake-compatcommands.html
 121        --help-compatcommands ${CMake_BINARY_DIR}/Docs/cmakecompat.1
 122   DEPENDS cmake
 123   MAIN_DEPENDENCY ${CMake_SOURCE_DIR}/Utilities/Doxygen/authors.txt
 124   )
 125
 126 install(FILES ${MAN_FILES} DESTINATION ${CMAKE_MAN_DIR}/man1)
 127 install(FILES
 128   ${TEXT_FILES}
 129   ${HTML_FILES}
 130   ${DOCBOOK_FILES}
 131   DESTINATION ${CMAKE_DOC_DIR}
 132   )
 133 install(FILES cmake.m4 DESTINATION share/aclocal)
 134
 135 # Drive documentation generation.
 136 add_custom_target(documentation ALL DEPENDS ${DOC_FILES} ${CMake_BINARY_DIR}/Docs/cmake.txt )
 137
 138 # Documentation testing.
 139 if(BUILD_TESTING)
 140   find_package(LibXml2 QUIET)
 141   if(NOT DEFINED LIBXML2_XMLLINT_EXECUTABLE)
 142     find_program(LIBXML2_XMLLINT_EXECUTABLE xmllint)
 143   endif()
 144   mark_as_advanced(LIBXML2_XMLLINT_EXECUTABLE)
 145   if(LIBXML2_XMLLINT_EXECUTABLE)
 146     execute_process(COMMAND ${LIBXML2_XMLLINT_EXECUTABLE} --help
 147       OUTPUT_VARIABLE _help ERROR_VARIABLE _err)
 148     if("${_help}" MATCHES "--path" AND "${_help}" MATCHES "--nonet")
 149       # We provide DTDs in the 'xml' directory so that xmllint can run without
 150       # network access.  Note that xmllints's --path option accepts a
 151       # space-separated list of url-encoded paths.
 152       set(_dtd_dir "${CMAKE_CURRENT_SOURCE_DIR}/xml")
 153       string(REPLACE " " "%20" _dtd_dir "${_dtd_dir}")
 154       string(REPLACE ":" "%3A" _dtd_dir "${_dtd_dir}")
 155       add_test(CMake.HTML
 156         ${LIBXML2_XMLLINT_EXECUTABLE} --valid --noout --nonet
 157         --path ${_dtd_dir}/xhtml1
 158         ${HTML_FILES}
 159         )
 160       add_test(CMake.DocBook
 161         ${LIBXML2_XMLLINT_EXECUTABLE} --valid --noout --nonet
 162         --path ${_dtd_dir}/docbook-4.5
 163         ${DOCBOOK_FILES}
 164         )
 165     endif()
 166   endif()
 167 endif()