summaryrefslogtreecommitdiffstats
path: root/Help/variable
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2019-10-15 15:16:55 (GMT)
committerKitware Robot <kwrobot@kitware.com>2019-10-15 15:17:03 (GMT)
commitcdc8d75c495b4a7c8151b0aca1f6ceb515d9135e (patch)
tree272cc3f48aebaee1b675a51c3e462f5283183b8a /Help/variable
parentdc164bccc1a5c3e3e20b8c4c1ee655e9d83d5779 (diff)
parentfb16e0e7c05c9c227f6fb2a6ec5dbcae95b12880 (diff)
downloadCMake-cdc8d75c495b4a7c8151b0aca1f6ceb515d9135e.zip
CMake-cdc8d75c495b4a7c8151b0aca1f6ceb515d9135e.tar.gz
CMake-cdc8d75c495b4a7c8151b0aca1f6ceb515d9135e.tar.bz2
Merge topic 'doc-static-lib-flags'
fb16e0e7c0 Help: Clarify documentation of CMAKE_STATIC_LINKER_FLAGS Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !3919
Diffstat (limited to 'Help/variable')
-rw-r--r--Help/variable/CMAKE_STATIC_LINKER_FLAGS.rst10
-rw-r--r--Help/variable/CMAKE_STATIC_LINKER_FLAGS_CONFIG.rst12
2 files changed, 17 insertions, 5 deletions
diff --git a/Help/variable/CMAKE_STATIC_LINKER_FLAGS.rst b/Help/variable/CMAKE_STATIC_LINKER_FLAGS.rst
index 9c38673..1a810ce 100644
--- a/Help/variable/CMAKE_STATIC_LINKER_FLAGS.rst
+++ b/Help/variable/CMAKE_STATIC_LINKER_FLAGS.rst
@@ -1,6 +1,12 @@
CMAKE_STATIC_LINKER_FLAGS
-------------------------
-Linker flags to be used to create static libraries.
+Flags to be used to create static libraries. These flags will be passed
+to the archiver when creating a static library.
-These flags will be used by the linker when creating a static library.
+See also :variable:`CMAKE_STATIC_LINKER_FLAGS_<CONFIG>`.
+
+.. note::
+ Static libraries do not actually link. They are essentially archives
+ of object files. The use of the name "linker" in the name of this
+ variable is kept for compatibility.
diff --git a/Help/variable/CMAKE_STATIC_LINKER_FLAGS_CONFIG.rst b/Help/variable/CMAKE_STATIC_LINKER_FLAGS_CONFIG.rst
index b9f8003..e561dc6 100644
--- a/Help/variable/CMAKE_STATIC_LINKER_FLAGS_CONFIG.rst
+++ b/Help/variable/CMAKE_STATIC_LINKER_FLAGS_CONFIG.rst
@@ -1,7 +1,13 @@
CMAKE_STATIC_LINKER_FLAGS_<CONFIG>
----------------------------------
-Flags to be used when linking a static library.
+Flags to be used to create static libraries. These flags will be passed
+to the archiver when creating a static library in the ``<CONFIG>``
+configuration.
-Same as ``CMAKE_C_FLAGS_*`` but used by the linker when creating static
-libraries.
+See also :variable:`CMAKE_STATIC_LINKER_FLAGS`.
+
+.. note::
+ Static libraries do not actually link. They are essentially archives
+ of object files. The use of the name "linker" in the name of this
+ variable is kept for compatibility.