summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2015-01-27 16:21:55 (GMT)
committerCMake Topic Stage <kwrobot@kitware.com>2015-01-27 16:21:55 (GMT)
commit095fc28a7e077441daf2e3e59fe34f85f3ea6775 (patch)
tree5e27c7bf0167640b86353cb7f792b86b8c056478 /Help
parent82ba50390f52226bdd4162e4108bc4f5226150d6 (diff)
parentc7310917e6b5efa6ef867ef5cabc5b5649d97b67 (diff)
downloadCMake-095fc28a7e077441daf2e3e59fe34f85f3ea6775.zip
CMake-095fc28a7e077441daf2e3e59fe34f85f3ea6775.tar.gz
CMake-095fc28a7e077441daf2e3e59fe34f85f3ea6775.tar.bz2
Merge topic 'doc-link_libraries-note'
c7310917 Help: Clarify status of link_libraries command
Diffstat (limited to 'Help')
-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 4616dd1..c916f77 100644
--- a/Help/manual/cmake-commands.7.rst
+++ b/Help/manual/cmake-commands.7.rst
@@ -68,6 +68,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
@@ -118,7 +119,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