install-guide/CMakeLists.txt

   1 #
   2 # This file is part of the GROMACS molecular simulation package.
   3 #
   4 # Copyright (c) 2014, by the GROMACS development team, led by
   5 # Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6 # and including many others, as listed in the AUTHORS file in the
   7 # top-level source directory and at http://www.gromacs.org.
   8 #
   9 # GROMACS is free software; you can redistribute it and/or
  10 # modify it under the terms of the GNU Lesser General Public License
  11 # as published by the Free Software Foundation; either version 2.1
  12 # of the License, or (at your option) any later version.
  13 #
  14 # GROMACS is distributed in the hope that it will be useful,
  15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17 # Lesser General Public License for more details.
  18 #
  19 # You should have received a copy of the GNU Lesser General Public
  20 # License along with GROMACS; if not, see
  21 # http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23 #
  24 # If you want to redistribute modifications to GROMACS, please
  25 # consider that scientific software is very special. Version
  26 # control is crucial - bugs must be traceable. We will be happy to
  27 # consider code for inclusion in the official distribution, but
  28 # derived work must not be called official GROMACS. Details are found
  29 # in the README & COPYING files - if they are missing, get the
  30 # official version at http://www.gromacs.org.
  31 #
  32 # To help us fund GROMACS development, we humbly ask that you cite
  33 # the research papers on the package. Check out http://www.gromacs.org.
  34
  35 set(INSTALL_GUIDE_BUILD_IS_POSSIBLE OFF)
  36 if(NOT ${CMAKE_BINARY_DIR} STREQUAL ${CMAKE_SOURCE_DIR})
  37     # We can only build the install guide outside of the source dir
  38     find_package(Pandoc)
  39     if(PANDOC_EXECUTABLE)
  40         set(INSTALL_GUIDE_BUILD_IS_POSSIBLE ON)
  41     endif()
  42 endif()
  43
  44 if(INSTALL_GUIDE_BUILD_IS_POSSIBLE)
  45     # Do replacement of CMake variables for version strings, etc.
  46     configure_file(configure-install-guide.cmake.in
  47         ${CMAKE_CURRENT_BINARY_DIR}/configure-install-guide.cmake
  48         @ONLY)
  49
  50     # This defers until build time the configuration of
  51     # install-guide.md, which could be faster
  52     add_custom_command(
  53         OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/install-guide.md
  54         COMMAND ${CMAKE_COMMAND}
  55             -P ${CMAKE_CURRENT_BINARY_DIR}/configure-install-guide.cmake
  56         DEPENDS
  57             ${CMAKE_CURRENT_BINARY_DIR}/configure-install-guide.cmake
  58             ${CMAKE_CURRENT_SOURCE_DIR}/install-guide.md
  59         COMMENT "Configuring install guide"
  60         VERBATIM
  61         )
  62
  63     # Make the HTML install guide
  64     add_custom_command(
  65         OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/install-guide.html
  66         COMMAND pandoc -t html -o ${CMAKE_CURRENT_BINARY_DIR}/install-guide.html install-guide.md -s --toc
  67         DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/install-guide.md
  68         VERBATIM
  69         )
  70
  71     # Make the INSTALL file for CPack for the tarball. This gets put
  72     # into the tarball via the CPack rules in the top-level
  73     # CMakeLists.txt
  74     add_custom_command(
  75         OUTPUT final/INSTALL
  76         COMMAND ${CMAKE_COMMAND} -E make_directory final
  77         COMMAND pandoc -t plain -o final/INSTALL install-guide.md
  78         DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/install-guide.md
  79         VERBATIM
  80         )
  81
  82     # Add a top-level target for the others to hook onto
  83     add_custom_target(install-guide
  84         DEPENDS
  85            ${CMAKE_CURRENT_BINARY_DIR}/install-guide.html
  86            final/INSTALL
  87         VERBATIM
  88         )
  89 endif()