From a6ab6b5db28d736e66b10a7d6d0105488ca2720d Mon Sep 17 00:00:00 2001 From: "M. Eric Irrgang" Date: Tue, 13 Nov 2018 15:43:32 +0300 Subject: [PATCH] Note GMX_ENABLE_CCACHE in build system docs. Added to the list in "Variables affecting compilation/linking". Fixes #2743 Change-Id: I1a3184fbda1d879db60fea2333bc4f7db95b0277 --- docs/dev-manual/build-system.rst | 12 ++++++++++++ docs/dev-manual/tools.rst | 10 ---------- 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/docs/dev-manual/build-system.rst b/docs/dev-manual/build-system.rst index 7394a1fd8d..cf5b38fb8a 100644 --- a/docs/dev-manual/build-system.rst +++ b/docs/dev-manual/build-system.rst @@ -208,6 +208,18 @@ Variables affecting compilation/linking subcounters which are available. Defaults to ``OFF``. +.. cmake:: GMX_ENABLE_CCACHE + + If set to ``ON``, attempts to set up the `ccache `_ + caching compiler wrapper to speed up repeated builds. + The ``ccache`` executable is searched for with ``find_package()`` if CMake + is being run with a compatible build type. + If the executable is found and a compatible compiler is configured, + CMake launch wrapper scripts are set. + If enabled, the ``ccache`` executable location discovered by CMake must be + accessible during build, as well. + Defaults to ``OFF`` to minimize build system complexity. + .. cmake:: GMX_INSTALL_DATASUBDIR Sets the subdirectory under CMAKE_INSTALL_DATADIR where GROMACS-specific diff --git a/docs/dev-manual/tools.rst b/docs/dev-manual/tools.rst index bd6e47c5b2..0b84988c27 100644 --- a/docs/dev-manual/tools.rst +++ b/docs/dev-manual/tools.rst @@ -63,16 +63,6 @@ Build system CMake Main tool used in the build system. -ccache - When ``GMX_ENABLE_CCACHE`` is set, the `ccache - `_ caching compiler wrapper must be found - on the PATH, together with a supported compiler, so that a caching - compiler wrapper will be used with CMake. Not all compilers are - supported. Refer to the ``GMX_ENABLE_CCACHE`` option in - ``CMakeLists.txt`` and to ``cmake/gmxManageCcache.cmake`` for - details. Please submit updates if you find that the current - configuration is too conservative. - packaging for distribution (CPack) unit testing (CTest) -- 2.11.4.GIT