From 4c2c2cfd680afb1e34705e07c15e9a1bbe164cf9 Mon Sep 17 00:00:00 2001 From: Brad King Date: Thu, 15 Jun 2006 10:51:41 -0400 Subject: [PATCH] BUG: Clarified documentation about custom command outputs and custom target dependencies. --- Source/cmAddCustomCommandCommand.h | 10 ++++++---- Source/cmAddCustomTargetCommand.h | 17 ++++++++++------- 2 files changed, 16 insertions(+), 11 deletions(-) diff --git a/Source/cmAddCustomCommandCommand.h b/Source/cmAddCustomCommandCommand.h index 7a40c477e..bacce8fa0 100644 --- a/Source/cmAddCustomCommandCommand.h +++ b/Source/cmAddCustomCommandCommand.h @@ -74,7 +74,9 @@ public: " [WORKING_DIRECTORY dir]\n" " [COMMENT comment])\n" "This defines a new command that can be executed during the build " - "process. Note that MAIN_DEPENDENCY is completely optional and is " + "process. The outputs named should be listed as source files in the " + "target for which they are to be generated. " + "Note that MAIN_DEPENDENCY is completely optional and is " "used as a suggestion to visual studio about where to hang the " "custom command. In makefile terms this creates a new target in the " "following form:\n" @@ -100,9 +102,9 @@ public: " POST_BUILD - run after the target has been built\n" "Note that the PRE_BUILD option is only supported on Visual " "Studio 7 or later. For all other generators PRE_BUILD " - "will be treated as PRE_LINK." - "If WORKING_DIRECTORY is specified the command a cd \"dir\" is " - "done prior to running the command."; + "will be treated as PRE_LINK. " + "If WORKING_DIRECTORY is specified the command will be executed " + "in the directory given."; } cmTypeMacro(cmAddCustomCommandCommand, cmCommand); diff --git a/Source/cmAddCustomTargetCommand.h b/Source/cmAddCustomTargetCommand.h index 7bc8c5d30..0624fc2b0 100644 --- a/Source/cmAddCustomTargetCommand.h +++ b/Source/cmAddCustomTargetCommand.h @@ -68,15 +68,18 @@ public: " [DEPENDS depend depend depend ... ])\n" " [WORKING_DIRECTORY dir]\n" "Adds a target with the given name that executes the given commands " - "every time the target is built. If the ALL option is specified " + "every time the target is built. If the ALL option is specified " "it indicates that this target should be added to the default build " - "target so that it will be run every time. " - "The command and arguments are optional. If not specified, " - "it will create an empty target. The ADD_DEPENDENCIES command can be " - "used in conjunction with this command to drive custom target " - "generation. The command cannot be called ALL. " + "target so that it will be run every time " + "(the command cannot be called ALL). " + "The command and arguments are optional and if not specified an " + "empty target will be created. " "If WORKING_DIRECTORY is set, then the command will be run in that " - "directory."; + "directory. " + "Dependencies listed with the DEPENDS argument may reference files " + "and outputs of custom commands created with ADD_CUSTOM_COMMAND. " + "Dependencies on other targets may be added using the " + "ADD_DEPENDENCIES command."; } cmTypeMacro(cmAddCustomTargetCommand, cmCommand);