Forráskód Böngészése

BUG: Clarified documentation about custom command outputs and custom target dependencies.

Brad King 19 éve
szülő
commit
4c2c2cfd68
2 módosított fájl, 16 hozzáadás és 11 törlés
  1. 6 4
      Source/cmAddCustomCommandCommand.h
  2. 10 7
      Source/cmAddCustomTargetCommand.h

+ 6 - 4
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);

+ 10 - 7
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);