summaryrefslogtreecommitdiffstats
path: root/Help/variable
diff options
context:
space:
mode:
authorCraig Scott <craig.scott@crascit.com>2020-05-23 05:19:46 (GMT)
committerCraig Scott <craig.scott@crascit.com>2020-05-24 09:10:14 (GMT)
commit00c0c27303007ce1485d864378683fa7f69628a9 (patch)
tree43833957c6a7c49b1519acb16d19d501e551a320 /Help/variable
parent62816ff88c6d1bd8d1c00de5ed448ee915d69e00 (diff)
downloadCMake-00c0c27303007ce1485d864378683fa7f69628a9.zip
CMake-00c0c27303007ce1485d864378683fa7f69628a9.tar.gz
CMake-00c0c27303007ce1485d864378683fa7f69628a9.tar.bz2
Help: Clarify how env vars and ..._INIT variables interact
Fixes: #20358
Diffstat (limited to 'Help/variable')
-rw-r--r--Help/variable/CMAKE_LANG_FLAGS_INIT.rst6
1 files changed, 5 insertions, 1 deletions
diff --git a/Help/variable/CMAKE_LANG_FLAGS_INIT.rst b/Help/variable/CMAKE_LANG_FLAGS_INIT.rst
index a88d122..4a034e8 100644
--- a/Help/variable/CMAKE_LANG_FLAGS_INIT.rst
+++ b/Help/variable/CMAKE_LANG_FLAGS_INIT.rst
@@ -5,7 +5,11 @@ Value used to initialize the :variable:`CMAKE_<LANG>_FLAGS` cache entry
the first time a build tree is configured for language ``<LANG>``.
This variable is meant to be set by a :variable:`toolchain file
<CMAKE_TOOLCHAIN_FILE>`. CMake may prepend or append content to
-the value based on the environment and target platform.
+the value based on the environment and target platform. For example,
+the contents of a ``xxxFLAGS`` environment variable will be prepended,
+where ``xxx`` will be language-specific but not necessarily the same as
+``<LANG>`` (e.g. :envvar:`CXXFLAGS` for ``CXX``, :envvar:`FFLAGS` for
+``Fortran``, and so on).
See also the configuration-specific
:variable:`CMAKE_<LANG>_FLAGS_<CONFIG>_INIT` variable.