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>
This commit is contained in:
Brad King 2013-09-19 14:06:14 -04:00
parent 5e2b499485
commit 1bdac7d5a6

View File

@ -56,14 +56,14 @@ public:
virtual const char* GetFullDocumentation() const virtual const char* GetFullDocumentation() const
{ {
return return
" add_dependencies(target-name depend-target1\n" " add_dependencies(<target> [<target-dependency>]...)\n"
" depend-target2 ...)\n" "Make a top-level <target> depend on other top-level targets to "
"Make a top-level target depend on other top-level targets. A " "ensure that they build before <target> does. "
"top-level target is one created by ADD_EXECUTABLE, ADD_LIBRARY, " "A top-level target is one created by ADD_EXECUTABLE, ADD_LIBRARY, "
"or ADD_CUSTOM_TARGET. Adding dependencies with this command " "or ADD_CUSTOM_TARGET. "
"can be used to make sure one target is built before another target. "
"Dependencies added to an IMPORTED target are followed transitively " "Dependencies added to an IMPORTED target are followed transitively "
"in its place since the target itself does not build. " "in its place since the target itself does not build. "
"\n"
"See the DEPENDS option of ADD_CUSTOM_TARGET " "See the DEPENDS option of ADD_CUSTOM_TARGET "
"and ADD_CUSTOM_COMMAND for adding file-level dependencies in custom " "and ADD_CUSTOM_COMMAND for adding file-level dependencies in custom "
"rules. See the OBJECT_DEPENDS option in " "rules. See the OBJECT_DEPENDS option in "