From 7b4b556e2dee72abe60f9dcc931fa59f20444f7f Mon Sep 17 00:00:00 2001 From: Tyler Yankee Date: Fri, 16 Jan 2026 11:44:56 -0500 Subject: [PATCH] Help: Fix description of `CMAKE_*_LINKER_FLAGS` variables Improve the wording on the behavior of the per-configuration variants of `CMAKE_*_LINKER_FLAGS`. In particular, note that these variables only apply to the specified build configuration, and replace the ambiguous reference to `CMAKE_C_FLAGS_*` with a precise description. Clarify that the "default" variants of these variables apply for all build configurations. Add links between pages for the default and per-configuration variables. --- Help/variable/CMAKE_EXE_LINKER_FLAGS.rst | 8 +++++++- Help/variable/CMAKE_EXE_LINKER_FLAGS_CONFIG.rst | 9 +++++++-- Help/variable/CMAKE_MODULE_LINKER_FLAGS.rst | 8 +++++++- Help/variable/CMAKE_MODULE_LINKER_FLAGS_CONFIG.rst | 8 +++++++- Help/variable/CMAKE_SHARED_LINKER_FLAGS.rst | 8 +++++++- Help/variable/CMAKE_SHARED_LINKER_FLAGS_CONFIG.rst | 9 +++++++-- 6 files changed, 42 insertions(+), 8 deletions(-) diff --git a/Help/variable/CMAKE_EXE_LINKER_FLAGS.rst b/Help/variable/CMAKE_EXE_LINKER_FLAGS.rst index 0bb08ce963..4e746eaa46 100644 --- a/Help/variable/CMAKE_EXE_LINKER_FLAGS.rst +++ b/Help/variable/CMAKE_EXE_LINKER_FLAGS.rst @@ -3,6 +3,12 @@ CMAKE_EXE_LINKER_FLAGS Linker flags to be used to create executables. -These flags will be used by the linker when creating an executable. +These flags will be used by the linker when creating an executable for all +build configurations. .. include:: ../variable/include/LINKER_FLAGS.rst + +See Also +^^^^^^^^ + +* :variable:`CMAKE_EXE_LINKER_FLAGS_` diff --git a/Help/variable/CMAKE_EXE_LINKER_FLAGS_CONFIG.rst b/Help/variable/CMAKE_EXE_LINKER_FLAGS_CONFIG.rst index 30aad2093f..7dac9e9520 100644 --- a/Help/variable/CMAKE_EXE_LINKER_FLAGS_CONFIG.rst +++ b/Help/variable/CMAKE_EXE_LINKER_FLAGS_CONFIG.rst @@ -3,7 +3,12 @@ CMAKE_EXE_LINKER_FLAGS_ Flags to be used when linking an executable. -Same as ``CMAKE_C_FLAGS_*`` but used by the linker when creating -executables. +These flags will be used by the linker when creating an executable for the +```` configuration. .. include:: ../variable/include/LINKER_FLAGS.rst + +See Also +^^^^^^^^ + +* :variable:`CMAKE_EXE_LINKER_FLAGS` diff --git a/Help/variable/CMAKE_MODULE_LINKER_FLAGS.rst b/Help/variable/CMAKE_MODULE_LINKER_FLAGS.rst index e74b6eef81..5e7797f559 100644 --- a/Help/variable/CMAKE_MODULE_LINKER_FLAGS.rst +++ b/Help/variable/CMAKE_MODULE_LINKER_FLAGS.rst @@ -3,6 +3,12 @@ CMAKE_MODULE_LINKER_FLAGS Linker flags to be used to create modules. -These flags will be used by the linker when creating a module. +These flags will be used by the linker when creating a module for all build +configurations. .. include:: ../variable/include/LINKER_FLAGS.rst + +See Also +^^^^^^^^ + +* :variable:`CMAKE_MODULE_LINKER_FLAGS_` diff --git a/Help/variable/CMAKE_MODULE_LINKER_FLAGS_CONFIG.rst b/Help/variable/CMAKE_MODULE_LINKER_FLAGS_CONFIG.rst index 693565a87c..864c45b86c 100644 --- a/Help/variable/CMAKE_MODULE_LINKER_FLAGS_CONFIG.rst +++ b/Help/variable/CMAKE_MODULE_LINKER_FLAGS_CONFIG.rst @@ -3,6 +3,12 @@ CMAKE_MODULE_LINKER_FLAGS_ Flags to be used when linking a module. -Same as ``CMAKE_C_FLAGS_*`` but used by the linker when creating modules. +These flags will be used by the linker when creating a module for the +```` configuration. .. include:: ../variable/include/LINKER_FLAGS.rst + +See Also +^^^^^^^^ + +* :variable:`CMAKE_MODULE_LINKER_FLAGS` diff --git a/Help/variable/CMAKE_SHARED_LINKER_FLAGS.rst b/Help/variable/CMAKE_SHARED_LINKER_FLAGS.rst index 93c84ee645..5a81879fcb 100644 --- a/Help/variable/CMAKE_SHARED_LINKER_FLAGS.rst +++ b/Help/variable/CMAKE_SHARED_LINKER_FLAGS.rst @@ -3,6 +3,12 @@ CMAKE_SHARED_LINKER_FLAGS Linker flags to be used to create shared libraries. -These flags will be used by the linker when creating a shared library. +These flags will be used by the linker when creating a shared library for all +build configurations. .. include:: ../variable/include/LINKER_FLAGS.rst + +See Also +^^^^^^^^ + +* :variable:`CMAKE_SHARED_LINKER_FLAGS_` diff --git a/Help/variable/CMAKE_SHARED_LINKER_FLAGS_CONFIG.rst b/Help/variable/CMAKE_SHARED_LINKER_FLAGS_CONFIG.rst index d0eb4fdadd..51b276b9f9 100644 --- a/Help/variable/CMAKE_SHARED_LINKER_FLAGS_CONFIG.rst +++ b/Help/variable/CMAKE_SHARED_LINKER_FLAGS_CONFIG.rst @@ -3,7 +3,12 @@ CMAKE_SHARED_LINKER_FLAGS_ Flags to be used when linking a shared library. -Same as ``CMAKE_C_FLAGS_*`` but used by the linker when creating shared -libraries. +These flags will be used by the linker when creating a shared library for the +```` configuration. .. include:: ../variable/include/LINKER_FLAGS.rst + +See Also +^^^^^^^^ + +* :variable:`CMAKE_SHARED_LINKER_FLAGS`