summaryrefslogtreecommitdiffstats
path: root/Help/manual
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2019-11-05 16:29:30 (GMT)
committerKitware Robot <kwrobot@kitware.com>2019-11-05 16:29:39 (GMT)
commita269c77edb7c9d55efa1fbac46ed84173a7dcbc9 (patch)
treea837b897c8346279499915b23bdfeaf8842c482c /Help/manual
parent13ea5f06fad9bd9645cf4fb768e476dd7a053dd1 (diff)
parent53cd86ea7846b55b7cb21886ea77482e626bbeb4 (diff)
downloadCMake-a269c77edb7c9d55efa1fbac46ed84173a7dcbc9.zip
CMake-a269c77edb7c9d55efa1fbac46ed84173a7dcbc9.tar.gz
CMake-a269c77edb7c9d55efa1fbac46ed84173a7dcbc9.tar.bz2
Merge topic 'clarify_compile_features_documentation'
53cd86ea78 Help: Clarify what 'aware' means as it relates to C++ standards Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !3988
Diffstat (limited to 'Help/manual')
-rw-r--r--Help/manual/cmake-compile-features.7.rst14
1 files changed, 7 insertions, 7 deletions
diff --git a/Help/manual/cmake-compile-features.7.rst b/Help/manual/cmake-compile-features.7.rst
index a9d4843..a821189 100644
--- a/Help/manual/cmake-compile-features.7.rst
+++ b/Help/manual/cmake-compile-features.7.rst
@@ -90,21 +90,21 @@ Requiring Language Standards
In projects that use a large number of commonly available features from
a particular language standard (e.g. C++ 11) one may specify a
meta-feature (e.g. ``cxx_std_11``) that requires use of a compiler mode
-aware of that standard. This is simpler than specifying all the
-features individually, but does not guarantee the existence of any
-particular feature. Diagnosis of use of unsupported features will be
-delayed until compile time.
+that is at minimum aware of that standard, but could be greater.
+This is simpler than specifying all the features individually, but does
+not guarantee the existence of any particular feature.
+Diagnosis of use of unsupported features will be delayed until compile time.
For example, if C++ 11 features are used extensively in a project's
-header files, then clients must use a compiler mode aware of C++ 11
-or above. This can be requested with the code:
+header files, then clients must use a compiler mode that is no less
+than C++ 11. This can be requested with the code:
.. code-block:: cmake
target_compile_features(mylib PUBLIC cxx_std_11)
In this example, CMake will ensure the compiler is invoked in a mode
-that is aware of C++ 11 (or above), adding flags such as
+of at-least C++ 11 (or C++ 14, C++ 17, ...), adding flags such as
``-std=gnu++11`` if necessary. This applies to sources within ``mylib``
as well as any dependents (that may include headers from ``mylib``).