Browse Source

Merge topic 'doc-static-lib-flags'

fb16e0e7c0 Help: Clarify documentation of CMAKE_STATIC_LINKER_FLAGS

Acked-by: Kitware Robot <[email protected]>
Merge-request: !3919
Brad King 6 years ago
parent
commit
cdc8d75c49

+ 8 - 2
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.

+ 9 - 3
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.