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>
This commit is contained in:
Brad King 2015-01-26 09:13:47 -05:00
parent 57622bd19d
commit c7310917e6
2 changed files with 12 additions and 9 deletions

View File

@ -1,16 +1,19 @@
link_libraries link_libraries
-------------- --------------
Deprecated. Use the target_link_libraries() command instead.
Link libraries to all targets added later. Link libraries to all targets added later.
:: ::
link_libraries(library1 <debug | optimized> library2 ...) link_libraries([item1 [item2 [...]]]
[[debug|optimized|general] <item>] ...)
Specify a list of libraries to be linked into any following targets Specify libraries or flags to use when linking any targets created later in
(typically added with the add_executable or add_library calls). This the current directory or below by commands such as :command:`add_executable`
command is passed down to all subdirectories. The debug and optimized or :command:`add_library`. See the :command:`target_link_libraries` command
strings may be used to indicate that the next library listed is to be for meaning of arguments.
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.

View File

@ -67,6 +67,7 @@ These commands may be used freely in CMake projects.
/command/include /command/include
/command/install /command/install
/command/link_directories /command/link_directories
/command/link_libraries
/command/list /command/list
/command/load_cache /command/load_cache
/command/load_command /command/load_command
@ -117,7 +118,6 @@ versions of CMake. Do not use them in new code.
/command/install_files /command/install_files
/command/install_programs /command/install_programs
/command/install_targets /command/install_targets
/command/link_libraries
/command/make_directory /command/make_directory
/command/output_required_files /command/output_required_files
/command/remove /command/remove