Merge branch release-2020
[gromacs.git] / CPackInit.cmake
blobbc25782886e629e6752b1d62e3d0b5a996ef94f8
2 # This file is part of the GROMACS molecular simulation package.
4 # Copyright (c) 2012,2013,2014,2015, 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.
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.
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.
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.
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.
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.
35 set(BUILDING_SOURCE_PACKAGE OFF)
36 # The essential difference in building a source package is that install() rules
37 # from the CMake project are not considered when deciding what to package.
38 # Instead, only the listed directories are packaged (and the listed directories
39 # contain the source tree).
40 if (NOT CPACK_INSTALL_CMAKE_PROJECTS)
41     set(BUILDING_SOURCE_PACKAGE ON)
42 endif()
44 if (BUILDING_SOURCE_PACKAGE)
45     # TODO: add check that source doesn't contain any untracked files
46     get_filename_component(CMAKE_BINARY_DIR ${CPACK_OUTPUT_CONFIG_FILE} PATH)
47     # TODO: The list could be generated at the same time as the list of
48     # directories to include to keep the probe file names at the same place.
49     # And this does not detect if things have been built in the past, but are
50     # outdated.
51     if (NOT EXISTS "${CMAKE_BINARY_DIR}/docs/man/gmx-view.1" OR
52         NOT EXISTS "${CMAKE_BINARY_DIR}/docs/install-guide/text/INSTALL" OR
53         NOT EXISTS "${CMAKE_BINARY_DIR}/src/programs/completion/gmx-completion.bash")
54         message(FATAL_ERROR
55             "To create a complete source package, bash completions, "
56             "man pages, and INSTALL need to be generated. "
57             "Run 'make completion man install-guide' to build "
58             "these parts (you will need Sphinx). You can also configure with "
59             "GMX_BUILD_HELP=ON to automatically build the completions.")
60     endif()
61 else()
62     # TODO: If GMX_BUILD_HELP is AUTO, it may happen that the generation
63     # fails, and things are silently left out.
64     # Also, it is currently impossible to get these files into the binary
65     # package for cross-compilation.  However, binary packages are not
66     # currently used much, either...
67     if (NOT CPACK_GMX_BUILD_HELP)
68         message(WARNING
69             "To create a complete binary package, bash completions and "
70             "man pages need to be generated. "
71             "You need to configure with GMX_BUILD_HELP=ON to include all "
72             "in the binary package.")
73         # Building the man etc. targets is not sufficient because then the
74         # install is still not done.
75     endif()
76 endif()