diff options
| author | Brad King <brad.king@kitware.com> | 2019-10-15 09:43:00 -0400 |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2019-10-15 09:43:00 -0400 |
| commit | fb16e0e7c05c9c227f6fb2a6ec5dbcae95b12880 (patch) | |
| tree | 1c436ad3170b161c8850b4665de463268a2a40f8 /Help | |
| parent | 9150c818b7d2afb868575fcb2e0c9ba62b9d7f85 (diff) | |
| download | cmake-fb16e0e7c05c9c227f6fb2a6ec5dbcae95b12880.tar.gz | |
Help: Clarify documentation of CMAKE_STATIC_LINKER_FLAGS
Issue: #19838
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/variable/CMAKE_STATIC_LINKER_FLAGS.rst | 10 | ||||
| -rw-r--r-- | Help/variable/CMAKE_STATIC_LINKER_FLAGS_CONFIG.rst | 12 |
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 9c38673aa4..1a810ce14c 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 b9f8003c7f..e561dc645b 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. |