summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2015-01-26 14:13:47 (GMT)
committerBrad King <brad.king@kitware.com>2015-01-26 14:15:00 (GMT)
commitc7310917e6b5efa6ef867ef5cabc5b5649d97b67 (patch)
tree7b9d86a4297c6a81abf89c21d0e12a7d14ae2267
parent57622bd19d3fd013038d34f497b106a7e2bfd26d (diff)
downloadCMake-c7310917e6b5efa6ef867ef5cabc5b5649d97b67.zip
CMake-c7310917e6b5efa6ef867ef5cabc5b5649d97b67.tar.gz
CMake-c7310917e6b5efa6ef867ef5cabc5b5649d97b67.tar.bz2
Help: Clarify status of link_libraries command
The command has been documented as 'deprecated', but it is not really slated for removal and can still be used. Clarify this in the documentation. While at it, revise the documentation to use wording more consistent with that now in target_link_libraries. Suggested-by: Christoph GrĂ¼ninger <foss@grueninger.de>
-rw-r--r--Help/command/link_libraries.rst19
-rw-r--r--Help/manual/cmake-commands.7.rst2
2 files changed, 12 insertions, 9 deletions
diff --git a/Help/command/link_libraries.rst b/Help/command/link_libraries.rst
index d690c9b..fd5dc37 100644
--- a/Help/command/link_libraries.rst
+++ b/Help/command/link_libraries.rst
@@ -1,16 +1,19 @@
link_libraries
--------------
-Deprecated. Use the target_link_libraries() command instead.
-
Link libraries to all targets added later.
::
- link_libraries(library1 <debug | optimized> library2 ...)
+ link_libraries([item1 [item2 [...]]]
+ [[debug|optimized|general] <item>] ...)
+
+Specify libraries or flags to use when linking any targets created later in
+the current directory or below by commands such as :command:`add_executable`
+or :command:`add_library`. See the :command:`target_link_libraries` command
+for meaning of arguments.
-Specify a list of libraries to be linked into any following targets
-(typically added with the add_executable or add_library calls). This
-command is passed down to all subdirectories. The debug and optimized
-strings may be used to indicate that the next library listed is to be
-used only for that specific type of build.
+.. note::
+ The :command:`target_link_libraries` command should be preferred whenever
+ possible. Library dependencies are chained automatically, so directory-wide
+ specification of link libraries is rarely needed.
diff --git a/Help/manual/cmake-commands.7.rst b/Help/manual/cmake-commands.7.rst
index 9c1d3b9..14871f2 100644
--- a/Help/manual/cmake-commands.7.rst
+++ b/Help/manual/cmake-commands.7.rst
@@ -67,6 +67,7 @@ These commands may be used freely in CMake projects.
/command/include
/command/install
/command/link_directories
+ /command/link_libraries
/command/list
/command/load_cache
/command/load_command
@@ -117,7 +118,6 @@ versions of CMake. Do not use them in new code.
/command/install_files
/command/install_programs
/command/install_targets
- /command/link_libraries
/command/make_directory
/command/output_required_files
/command/remove