From b33a6d8ae984e37d5f2f05f81f18341202c109e7 Mon Sep 17 00:00:00 2001 From: "Roscoe A. Bartlett" Date: Fri, 26 Aug 2022 16:45:10 -0600 Subject: [PATCH] More minor tweaks to documentation I noticed these while reading the documentation online. --- .../build_ref/TribitsBuildReferenceBody.rst | 32 ++++++++++--------- 1 file changed, 17 insertions(+), 15 deletions(-) diff --git a/tribits/doc/build_ref/TribitsBuildReferenceBody.rst b/tribits/doc/build_ref/TribitsBuildReferenceBody.rst index 5db570bb1..30068693d 100644 --- a/tribits/doc/build_ref/TribitsBuildReferenceBody.rst +++ b/tribits/doc/build_ref/TribitsBuildReferenceBody.rst @@ -275,7 +275,7 @@ b) Create a ``*.cmake`` file and point to it [Most Recommended]. project source directory location may not be known or easy to get). 2) When configuration files are read in using - ``_CONFIGURE_OPTIONS_FILE``, the will get reprocessed on every + ``_CONFIGURE_OPTIONS_FILE``, they will get reprocessed on every reconfigure (such as when reconfigure happens automatically when running ``make``). That means that if options change in those included ``*.cmake`` files from the initial configure, then those updated options will get @@ -287,17 +287,18 @@ b) Create a ``*.cmake`` file and point to it [Most Recommended]. contents of the ``.cmake`` file reread on reconfigures, then one would want to use ``-C .cmake``. - 3) One can create and use parameterized ``*.cmake`` files that can be used - with multiple TriBITS projects. For example, one can have set statements - like ``set(${PROJECT_NAME}_ENABLE_Fortran OFF ...)`` since ``PROJECT_NAME`` - is known before the file is included. One can't do that with ``cmake -C`` - and instead would have to the full variables names specific for a given - project. + 3) When using ``_CONFIGURE_OPTIONS_FILE``, one can create and use + parameterized ``*.cmake`` files that can be used with multiple TriBITS + projects. For example, one can have set statements like + ``set(${PROJECT_NAME}_ENABLE_Fortran OFF ...)`` since ``PROJECT_NAME`` is + known before the file is included. One cannot do that with ``-C`` and + instead would have to provide the full variables names specific for a given + TriBITS project. - 4) Non-cache project-level variables can be set in a ``*.cmake`` file that - will impact the configuration. When using the ``-C`` option, only variables - set with ``set( CACHE ...)`` will impact the - configuration. + 4) When using ``_CONFIGURE_OPTIONS_FILE``, non-cache project-level + variables can be set in a ``*.cmake`` file that will impact the + configuration. When using the ``-C`` option, only variables set with + ``set( CACHE ...)`` will impact the configuration. 5) Cache variables forced set with ``set( CACHE "" FORCE)`` in a ``.cmake`` file pulled in with ``-C @@ -316,10 +317,11 @@ b) Create a ``*.cmake`` file and point to it [Most Recommended]. ``-D_CONFIGURE_OPTIONS_FILE=.cmake``, then a ``set( CACHE "" FORCE)`` statement in a ``.cmake`` **WILL** override a cache variable passed in on the command-line - ``-D=`` no matter the order of the arguments ``-D - _CONFIGURE_OPTIONS_FILE=.cmake`` and ``-D=``. - (This is because the file ``.cmake`` is included as part of the - processing of the project's top-level ``CMakeLists.txt`` file.) + ``-D=`` no matter the order of the arguments + ``-D_CONFIGURE_OPTIONS_FILE=.cmake`` and + ``-D=``. (This is because the file ``.cmake`` is + included as part of the processing of the project's top-level + ``CMakeLists.txt`` file.) 6) However, the ``*.cmake`` files specified by ``_CONFIGURE_OPTIONS_FILE`` will only get read in **after** the