Merge topic 'env2'

26a70449cc Help: Describe environment variables as such.

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !2609

Help/envvar/ASM_DIALECT.rst

@@ -1,6 +1,8 @@
 ASM<DIALECT>
 ------------
 
+.. include:: ENV_VAR.txt
+
 Preferred executable for compiling a specific dialect of assembly language
 files. ``ASM<DIALECT>`` can be ``ASM``, ``ASM_NASM``, ``ASM_MASM`` or
 ``ASM-ATT``. Will only be used by CMake on the first configuration to determine

Help/envvar/ASM_DIALECTFLAGS.rst

@@ -1,6 +1,8 @@
 ASM<DIALECT>FLAGS
 -----------------
 
+.. include:: ENV_VAR.txt
+
 Default compilation flags to be used when compiling a specific dialect of an
 assembly language. ``ASM<DIALECT>FLAGS`` can be ``ASMFLAGS``, ``ASM_NASMFLAGS``,
 ``ASM_MASMFLAGS`` or ``ASM-ATTFLAGS``. Will only be used by CMake on the

Help/envvar/CC.rst

@@ -1,6 +1,8 @@
 CC
 --
 
+.. include:: ENV_VAR.txt
+
 Preferred executable for compiling ``C`` language files. Will only be used by
 CMake on the first configuration to determine ``C`` compiler, after which the
 value for ``CC`` is stored in the cache as

Help/envvar/CFLAGS.rst

@@ -1,6 +1,8 @@
 CFLAGS
 ------
 
+.. include:: ENV_VAR.txt
+
 Default compilation flags to be used when compiling ``C`` files. Will only be
 used by CMake on the first configuration to determine ``CC`` default compilation
 flags, after which the value for ``CFLAGS`` is stored in the cache

Help/envvar/CMAKE_BUILD_PARALLEL_LEVEL.rst

@@ -1,6 +1,8 @@
 CMAKE_BUILD_PARALLEL_LEVEL
 --------------------------
 
+.. include:: ENV_VAR.txt
+
 Specifies the maximum number of concurrent processes to use when building
 using the ``cmake --build`` command line
 :ref:`Build Tool Mode <Build Tool Mode>`.

Help/envvar/CMAKE_CONFIG_TYPE.rst

@@ -1,5 +1,7 @@
 CMAKE_CONFIG_TYPE
 -----------------
 
+.. include:: ENV_VAR.txt
+
 The default build configuration for :ref:`Build Tool Mode` and
 ``ctest`` build handler when there is no explicit configuration given.

Help/envvar/CMAKE_MSVCIDE_RUN_PATH.rst

@@ -1,6 +1,8 @@
 CMAKE_MSVCIDE_RUN_PATH
 ----------------------
 
+.. include:: ENV_VAR.txt
+
 Extra PATH locations for custom commands when using
 :generator:`Visual Studio 9 2008` (or above) generators.
 

Help/envvar/CMAKE_OSX_ARCHITECTURES.rst

@@ -1,6 +1,8 @@
 CMAKE_OSX_ARCHITECTURES
 -----------------------
 
+.. include:: ENV_VAR.txt
+
 Target specific architectures for macOS.
 
 The ``CMAKE_OSX_ARCHITECTURES`` environment variable sets the default value for

Help/envvar/CSFLAGS.rst

@@ -1,6 +1,8 @@
 CSFLAGS
 -------
 
+.. include:: ENV_VAR.txt
+
 Preferred executable for compiling ``CSharp`` language files. Will only be
 used by CMake on the first configuration to determine ``CSharp`` default
 compilation flags, after which the value for ``CSFLAGS`` is stored in the cache

Help/envvar/CTEST_INTERACTIVE_DEBUG_MODE.rst

@@ -1,5 +1,7 @@
 CTEST_INTERACTIVE_DEBUG_MODE
 ----------------------------
 
+.. include:: ENV_VAR.txt
+
 Environment variable that will exist and be set to ``1`` when a test executed
 by CTest is run in interactive mode.

Help/envvar/CTEST_OUTPUT_ON_FAILURE.rst

@@ -1,6 +1,8 @@
 CTEST_OUTPUT_ON_FAILURE
 -----------------------
 
+.. include:: ENV_VAR.txt
+
 Boolean environment variable that controls if the output should be logged for
 failed tests. Set the value to 1, True, or ON to enable output on failure.
 See :manual:`ctest(1)` for more information on controlling output of failed

Help/envvar/CTEST_PARALLEL_LEVEL.rst

@@ -1,5 +1,7 @@
 CTEST_PARALLEL_LEVEL
 --------------------
 
+.. include:: ENV_VAR.txt
+
 Specify the number of tests for CTest to run in parallel. See :manual:`ctest(1)`
 for more information on parallel test execution.

Help/envvar/CTEST_PROGRESS_OUTPUT.rst

@@ -1,6 +1,8 @@
 CTEST_PROGRESS_OUTPUT
 ---------------------
 
+.. include:: ENV_VAR.txt
+
 Boolean environment variable that affects how :manual:`ctest <ctest(1)>`
 command output reports overall progress.  When set to 1, TRUE, ON or anything
 else that evaluates to boolean true, progress is reported by repeatedly

Help/envvar/CTEST_USE_LAUNCHERS_DEFAULT.rst

@@ -1,4 +1,6 @@
 CTEST_USE_LAUNCHERS_DEFAULT
 ---------------------------
 
+.. include:: ENV_VAR.txt
+
 Initializes the :variable:`CTEST_USE_LAUNCHERS` variable if not already defined.

Help/envvar/CUDACXX.rst

@@ -1,6 +1,8 @@
 CUDACXX
 -------
 
+.. include:: ENV_VAR.txt
+
 Preferred executable for compiling ``CUDA`` language files. Will only be used by
 CMake on the first configuration to determine ``CUDA`` compiler, after which the
 value for ``CUDA`` is stored in the cache as

Help/envvar/CUDAFLAGS.rst

@@ -1,6 +1,8 @@
 CUDAFLAGS
 ---------
 
+.. include:: ENV_VAR.txt
+
 Default compilation flags to be used when compiling ``CUDA`` files. Will only be
 used by CMake on the first configuration to determine ``CUDA`` default
 compilation flags, after which the value for ``CUDAFLAGS`` is stored in the

Help/envvar/CUDAHOSTCXX.rst

@@ -1,6 +1,8 @@
 CUDAHOSTCXX
 -----------
 
+.. include:: ENV_VAR.txt
+
 Preferred executable for compiling host code when compiling ``CUDA``
 language files. Will only be used by CMake on the first configuration to
 determine ``CUDA`` host compiler, after which the value for ``CUDAHOSTCXX`` is

Help/envvar/CXX.rst

@@ -1,6 +1,8 @@
 CXX
 ---
 
+.. include:: ENV_VAR.txt
+
 Preferred executable for compiling ``CXX`` language files. Will only be used by
 CMake on the first configuration to determine ``CXX`` compiler, after which the
 value for ``CXX`` is stored in the cache as

Help/envvar/CXXFLAGS.rst

@@ -1,6 +1,8 @@
 CXXFLAGS
 --------
 
+.. include:: ENV_VAR.txt
+
 Default compilation flags to be used when compiling ``CXX`` (C++) files. Will
 only be used by CMake on the first configuration to determine ``CXX`` default
 compilation flags, after which the value for ``CXXFLAGS`` is stored in the cache

Help/envvar/DASHBOARD_TEST_FROM_CTEST.rst

@@ -1,5 +1,7 @@
 DASHBOARD_TEST_FROM_CTEST
 -------------------------
 
+.. include:: ENV_VAR.txt
+
 Environment variable that will exist when a test executed by CTest is run
 in non-interactive mode. The value will be equal to :variable:`CMAKE_VERSION`.

Help/envvar/DESTDIR.rst

@@ -1,6 +1,8 @@
 DESTDIR
 -------
 
+.. include:: ENV_VAR.txt
+
 On UNIX one can use the ``DESTDIR`` mechanism in order to relocate the
 whole installation.  ``DESTDIR`` means DESTination DIRectory.  It is
 commonly used by makefile users in order to install software at

Help/envvar/ENV_VAR.txt

@@ -0,0 +1,3 @@
+This is a CMake :ref:`Environment Variable <CMake Language
+Environment Variables>`. Its initial value is taken from
+the calling process environment.

Help/envvar/FC.rst

@@ -1,6 +1,8 @@
 FC
 --
 
+.. include:: ENV_VAR.txt
+
 Preferred executable for compiling ``Fortran`` language files. Will only be used
 by CMake on the first configuration to determine ``Fortran`` compiler, after
 which the value for ``Fortran`` is stored in the cache as

Help/envvar/FFLAGS.rst

@@ -1,6 +1,8 @@
 FFLAGS
 ------
 
+.. include:: ENV_VAR.txt
+
 Default compilation flags to be used when compiling ``Fortran`` files. Will only
 be used by CMake on the first configuration to determine ``Fortran`` default
 compilation flags, after which the value for ``FFLAGS`` is stored in the cache

Help/envvar/LDFLAGS.rst

@@ -1,6 +1,8 @@
 LDFLAGS
 -------
 
+.. include:: ENV_VAR.txt
+
 Will only be used by CMake on the first configuration to determine the default
 linker flags, after which the value for ``LDFLAGS`` is stored in the cache
 as :variable:`CMAKE_EXE_LINKER_FLAGS_INIT`,

Help/envvar/MACOSX_DEPLOYMENT_TARGET.rst

@@ -1,6 +1,8 @@
 MACOSX_DEPLOYMENT_TARGET
 ------------------------
 
+.. include:: ENV_VAR.txt
+
 Specify the minimum version of macOS on which the target binaries are
 to be deployed.
 

Help/envvar/PackageName_ROOT.rst

@@ -1,6 +1,8 @@
 <PackageName>_ROOT
 ------------------
 
+.. include:: ENV_VAR.txt
+
 Calls to :command:`find_package(<PackageName>)` will search in prefixes
 specified by the ``<PackageName>_ROOT`` environment variable, where
 ``<PackageName>`` is the name given to the ``find_package`` call

Help/envvar/RC.rst

@@ -1,6 +1,8 @@
 RC
 --
 
+.. include:: ENV_VAR.txt
+
 Preferred executable for compiling ``resource`` files. Will only be used by CMake
 on the first configuration to determine ``resource`` compiler, after which the
 value for ``RC`` is stored in the cache as

Help/envvar/RCFLAGS.rst

@@ -1,6 +1,8 @@
 RCFLAGS
 -------
 
+.. include:: ENV_VAR.txt
+
 Default compilation flags to be used when compiling ``resource`` files. Will
 only be used by CMake on the first configuration to determine ``resource``
 default compilation flags, after which the value for ``RCFLAGS`` is stored in