summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2016-05-24 13:58:48 (GMT)
committerBrad King <brad.king@kitware.com>2016-05-24 15:40:25 (GMT)
commit7807b3a9db35acd683fd82c6d902272991a9789a (patch)
tree20013d412c3b42a2c31a3ffe84d7752abcc61633 /Help
parentecb4ad2aa2f5de4bbf4ef7c49d70c700f2c28b4e (diff)
downloadCMake-7807b3a9db35acd683fd82c6d902272991a9789a.zip
CMake-7807b3a9db35acd683fd82c6d902272991a9789a.tar.gz
CMake-7807b3a9db35acd683fd82c6d902272991a9789a.tar.bz2
Help: Document CMAKE_<LANG>_STANDARD_LIBRARIES variable
Also drop documentation of non-existent CMAKE_STANDARD_LIBRARIES variable.
Diffstat (limited to 'Help')
-rw-r--r--Help/manual/cmake-variables.7.rst2
-rw-r--r--Help/release/dev/doc-standard-libs.rst6
-rw-r--r--Help/variable/CMAKE_LANG_STANDARD_LIBRARIES.rst10
-rw-r--r--Help/variable/CMAKE_STANDARD_LIBRARIES.rst7
4 files changed, 17 insertions, 8 deletions
diff --git a/Help/manual/cmake-variables.7.rst b/Help/manual/cmake-variables.7.rst
index ec741ae..925b70c 100644
--- a/Help/manual/cmake-variables.7.rst
+++ b/Help/manual/cmake-variables.7.rst
@@ -68,7 +68,6 @@ Variables that Provide Information
/variable/CMAKE_SKIP_INSTALL_RULES
/variable/CMAKE_SKIP_RPATH
/variable/CMAKE_SOURCE_DIR
- /variable/CMAKE_STANDARD_LIBRARIES
/variable/CMAKE_STATIC_LIBRARY_PREFIX
/variable/CMAKE_STATIC_LIBRARY_SUFFIX
/variable/CMAKE_TOOLCHAIN_FILE
@@ -366,6 +365,7 @@ Variables for Languages
/variable/CMAKE_LANG_SIMULATE_VERSION
/variable/CMAKE_LANG_SIZEOF_DATA_PTR
/variable/CMAKE_LANG_SOURCE_FILE_EXTENSIONS
+ /variable/CMAKE_LANG_STANDARD_LIBRARIES
/variable/CMAKE_USER_MAKE_RULES_OVERRIDE_LANG
Variables for CTest
diff --git a/Help/release/dev/doc-standard-libs.rst b/Help/release/dev/doc-standard-libs.rst
new file mode 100644
index 0000000..6a99037
--- /dev/null
+++ b/Help/release/dev/doc-standard-libs.rst
@@ -0,0 +1,6 @@
+doc-standard-libs
+-----------------
+
+* The :variable:`CMAKE_<LANG>_STANDARD_LIBRARIES` variable is now documented.
+ It is intended for use by toolchain files to specify system libraries to be
+ added to all linker command lines.
diff --git a/Help/variable/CMAKE_LANG_STANDARD_LIBRARIES.rst b/Help/variable/CMAKE_LANG_STANDARD_LIBRARIES.rst
new file mode 100644
index 0000000..ad3b911
--- /dev/null
+++ b/Help/variable/CMAKE_LANG_STANDARD_LIBRARIES.rst
@@ -0,0 +1,10 @@
+CMAKE_<LANG>_STANDARD_LIBRARIES
+-------------------------------
+
+Libraries linked into every executable and shared library linked
+for language ``<LANG>``. This is meant for specification of system
+libraries needed by the language for the current platform.
+
+This variable should not be set by project code. It is meant to be set by
+CMake's platform information modules for the current toolchain, or by a
+toolchain file when used with :variable:`CMAKE_TOOLCHAIN_FILE`.
diff --git a/Help/variable/CMAKE_STANDARD_LIBRARIES.rst b/Help/variable/CMAKE_STANDARD_LIBRARIES.rst
deleted file mode 100644
index 9c728cd..0000000
--- a/Help/variable/CMAKE_STANDARD_LIBRARIES.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-CMAKE_STANDARD_LIBRARIES
-------------------------
-
-Libraries linked into every executable and shared library.
-
-This is the list of libraries that are linked into all executables and
-libraries.