summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorAlexander Richardson <arichardson.kde@gmail.com>2021-03-16 13:19:21 (GMT)
committerBrad King <brad.king@kitware.com>2021-03-17 13:22:52 (GMT)
commit95c50da8af070999f5302ed19d807b59451d8c85 (patch)
tree0542cfd94e9c753e05a568751f02a227d492aec6 /Help
parent0cf1b5c5adca7061f5d65eef602eca180c8fecb7 (diff)
downloadCMake-95c50da8af070999f5302ed19d807b59451d8c85.zip
CMake-95c50da8af070999f5302ed19d807b59451d8c85.tar.gz
CMake-95c50da8af070999f5302ed19d807b59451d8c85.tar.bz2
Help: Document that CMAKE_<LANG>_FLAGS[_INIT] are strings
Issue: #21944
Diffstat (limited to 'Help')
-rw-r--r--Help/variable/CMAKE_LANG_FLAGS.rst3
-rw-r--r--Help/variable/CMAKE_LANG_FLAGS_INIT.rst2
2 files changed, 5 insertions, 0 deletions
diff --git a/Help/variable/CMAKE_LANG_FLAGS.rst b/Help/variable/CMAKE_LANG_FLAGS.rst
index 14b2694..11864f8 100644
--- a/Help/variable/CMAKE_LANG_FLAGS.rst
+++ b/Help/variable/CMAKE_LANG_FLAGS.rst
@@ -15,3 +15,6 @@ This is initialized for each language from environment variables:
Initialized by the :envvar:`CUDAFLAGS` environment variable.
* ``CMAKE_Fortran_FLAGS``:
Initialized by the :envvar:`FFLAGS` environment variable.
+
+This value is a command-line string fragment. Therefore, multiple options
+should be separated by spaces, and options with spaces should be quoted.
diff --git a/Help/variable/CMAKE_LANG_FLAGS_INIT.rst b/Help/variable/CMAKE_LANG_FLAGS_INIT.rst
index 67ff2cb..ca13a29 100644
--- a/Help/variable/CMAKE_LANG_FLAGS_INIT.rst
+++ b/Help/variable/CMAKE_LANG_FLAGS_INIT.rst
@@ -12,6 +12,8 @@ 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).
+This value is a command-line string fragment. Therefore, multiple options
+should be separated by spaces, and options with spaces should be quoted.
See also the configuration-specific
:variable:`CMAKE_<LANG>_FLAGS_<CONFIG>_INIT` variable.