diff options
Diffstat (limited to 'Source/cmAddCustomTargetCommand.h')
| -rw-r--r-- | Source/cmAddCustomTargetCommand.h | 26 |
1 files changed, 20 insertions, 6 deletions
diff --git a/Source/cmAddCustomTargetCommand.h b/Source/cmAddCustomTargetCommand.h index 4a448b3..b8808b8 100644 --- a/Source/cmAddCustomTargetCommand.h +++ b/Source/cmAddCustomTargetCommand.h @@ -65,10 +65,16 @@ public: return " ADD_CUSTOM_TARGET(Name [ALL] [command1 [args1...]]\n" " [COMMAND command2 [args2...] ...]\n" - " [DEPENDS depend depend depend ... ])\n" + " [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 " + " [COMMENT comment] [VERBATIM])\n" + "Adds a target with the given name that executes the given commands. " + "The target has no output file and is ALWAYS CONSIDERED OUT OF DATE " + "even if the commands try to create a file with the name of the " + "target. Use ADD_CUSTOM_COMMAND to generate a file with dependencies. " + "By default nothing depends on the custom target. Use " + "ADD_DEPENDENCIES to add dependencies to or from other targets. " + "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 cannot be called ALL). " @@ -76,10 +82,18 @@ public: "empty target will be created. " "If WORKING_DIRECTORY is set, then the command will be run in that " "directory. " + "If COMMENT is set, the value will be displayed as a " + "message before the commands are executed at build time. " "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."; + "and outputs of custom commands created with ADD_CUSTOM_COMMAND.\n" + "If VERBATIM is given then all the arguments to the commands will be " + "passed exactly as specified no matter the build tool used. " + "Note that one level of escapes is still used by the CMake language " + "processor before ADD_CUSTOM_TARGET even sees the arguments. " + "Use of VERBATIM is recommended as it enables correct behavior. " + "When VERBATIM is not given the behavior is platform specific. " + "In the future VERBATIM may be enabled by default. The only reason " + "it is an option is to preserve compatibility with older CMake code."; } cmTypeMacro(cmAddCustomTargetCommand, cmCommand); |