diff options
author | Brad King <brad.king@kitware.com> | 2013-09-19 18:06:14 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2013-09-19 18:10:23 (GMT) |
commit | 1bdac7d5a65fe97e01346df105f15a98b76daf30 (patch) | |
tree | 0806b5162ea068e728d3d06a762b5575fdce575b /Source | |
parent | 5e2b499485d9a418b2ccb191f3d33b5ee34dbb1f (diff) | |
download | CMake-1bdac7d5a65fe97e01346df105f15a98b76daf30.zip CMake-1bdac7d5a65fe97e01346df105f15a98b76daf30.tar.gz CMake-1bdac7d5a65fe97e01346df105f15a98b76daf30.tar.bz2 |
add_dependencies: Clarify direction of dependency in docs (#14424)
State explicitly that the dependencies will build before the target.
Drop wording that may imply the opposite.
Suggested-by: Rob Stewart <robert.stewart@sig.com>
Diffstat (limited to 'Source')
-rw-r--r-- | Source/cmAddDependenciesCommand.h | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/Source/cmAddDependenciesCommand.h b/Source/cmAddDependenciesCommand.h index ed80067..148fd99 100644 --- a/Source/cmAddDependenciesCommand.h +++ b/Source/cmAddDependenciesCommand.h @@ -56,14 +56,14 @@ public: virtual const char* GetFullDocumentation() const { return - " add_dependencies(target-name depend-target1\n" - " depend-target2 ...)\n" - "Make a top-level target depend on other top-level targets. A " - "top-level target is one created by ADD_EXECUTABLE, ADD_LIBRARY, " - "or ADD_CUSTOM_TARGET. Adding dependencies with this command " - "can be used to make sure one target is built before another target. " + " add_dependencies(<target> [<target-dependency>]...)\n" + "Make a top-level <target> depend on other top-level targets to " + "ensure that they build before <target> does. " + "A top-level target is one created by ADD_EXECUTABLE, ADD_LIBRARY, " + "or ADD_CUSTOM_TARGET. " "Dependencies added to an IMPORTED target are followed transitively " "in its place since the target itself does not build. " + "\n" "See the DEPENDS option of ADD_CUSTOM_TARGET " "and ADD_CUSTOM_COMMAND for adding file-level dependencies in custom " "rules. See the OBJECT_DEPENDS option in " |