diff options
| author | Craig Scott <craig.scott@crascit.com> | 2022-06-27 10:36:58 (GMT) |
|---|---|---|
| committer | Craig Scott <craig.scott@crascit.com> | 2022-07-03 04:34:41 (GMT) |
| commit | d185f7c0a8cac19edaea8d54c2a12b51a622731b (patch) | |
| tree | 96ab4b102d1d8a94536b0e09915d2911d3c505d5 /Help/variable/CMAKE_LINK_GROUP_USING_FEATURE.rst | |
| parent | 8c562ece28b7a13ddb734b8c51710ebafe9ac570 (diff) | |
| download | CMake-d185f7c0a8cac19edaea8d54c2a12b51a622731b.zip CMake-d185f7c0a8cac19edaea8d54c2a12b51a622731b.tar.gz CMake-d185f7c0a8cac19edaea8d54c2a12b51a622731b.tar.bz2 | |
Help: Rework $<LINK_LIBRARY>, $<LINK_GROUP> and related docs
These changes restructure the docs to improve readability and flow,
correct grammar and typos, and fix errors and inconsistencies in
some of the examples.
Fixes: #23684
Diffstat (limited to 'Help/variable/CMAKE_LINK_GROUP_USING_FEATURE.rst')
| -rw-r--r-- | Help/variable/CMAKE_LINK_GROUP_USING_FEATURE.rst | 35 |
1 files changed, 12 insertions, 23 deletions
diff --git a/Help/variable/CMAKE_LINK_GROUP_USING_FEATURE.rst b/Help/variable/CMAKE_LINK_GROUP_USING_FEATURE.rst index 692c099..90b7f8b 100644 --- a/Help/variable/CMAKE_LINK_GROUP_USING_FEATURE.rst +++ b/Help/variable/CMAKE_LINK_GROUP_USING_FEATURE.rst @@ -3,31 +3,20 @@ CMAKE_LINK_GROUP_USING_<FEATURE> .. versionadded:: 3.24 -This variable defines, for the specified ``<FEATURE>``, the expression expected -by the linker when libraries are specified using :genex:`LINK_GROUP` generator -expression. +This variable defines how to link a group of libraries for the specified +``<FEATURE>`` when a :genex:`LINK_GROUP` generator expression is used. +Both of the following conditions must be met for this variable to have any +effect: -.. note:: +* The associated :variable:`CMAKE_LINK_GROUP_USING_<FEATURE>_SUPPORTED` + variable must be set to true. - * Feature names can contain Latin letters, digits and undercores. - * Feature names defined in all uppercase are reserved to CMake. +* There is no language-specific definition for the same ``<FEATURE>``. + This means :variable:`CMAKE_<LANG>_LINK_GROUP_USING_<FEATURE>_SUPPORTED` + cannot be true for the link language used by the target for which the + :genex:`LINK_GROUP` generator expression is evaluated. -See also the associated variable -:variable:`CMAKE_LINK_GROUP_USING_<FEATURE>_SUPPORTED` and -:variable:`CMAKE_<LANG>_LINK_GROUP_USING_<FEATURE>` variable for the definition -of features dependent from the link language. - -This variable will be used by :genex:`LINK_GROUP` generator expression if, -for the linker language, the variable -:variable:`CMAKE_<LANG>_LINK_GROUP_USING_<FEATURE>_SUPPORTED` is not defined -and the variable :variable:`CMAKE_LINK_GROUP_USING_<FEATURE>_SUPPORTED` is -``TRUE``.. +The :variable:`CMAKE_<LANG>_LINK_GROUP_USING_<FEATURE>` variable should be +defined instead for features that are dependent on the link language. .. include:: CMAKE_LINK_GROUP_USING_FEATURE.txt - -Predefined Features -^^^^^^^^^^^^^^^^^^^ - -CMake pre-defines some features of general interest: - -.. include:: LINK_GROUP_PREDEFINED_FEATURES.txt |