summaryrefslogtreecommitdiffstats
path: root/Source/cmMessageCommand.h
diff options
context:
space:
mode:
authorBill Hoffman <bill.hoffman@kitware.com>2006-01-25 16:07:46 (GMT)
committerBill Hoffman <bill.hoffman@kitware.com>2006-01-25 16:07:46 (GMT)
commit269b66d50aba8285f3ad7935141968dd33dcd820 (patch)
treeba593cb08e99de64e1734f3f0b8fa181a42417f8 /Source/cmMessageCommand.h
parent0205c6bb1a88909fe373a4b425eab0dc6a7495de (diff)
downloadCMake-269b66d50aba8285f3ad7935141968dd33dcd820.zip
CMake-269b66d50aba8285f3ad7935141968dd33dcd820.tar.gz
CMake-269b66d50aba8285f3ad7935141968dd33dcd820.tar.bz2
ENH: fix docs, and revert fatal error change
Diffstat (limited to 'Source/cmMessageCommand.h')
-rw-r--r--Source/cmMessageCommand.h11
1 files changed, 8 insertions, 3 deletions
diff --git a/Source/cmMessageCommand.h b/Source/cmMessageCommand.h
index 15b56f9..c993351 100644
--- a/Source/cmMessageCommand.h
+++ b/Source/cmMessageCommand.h
@@ -66,9 +66,14 @@ public:
return
" MESSAGE([SEND_ERROR | STATUS | FATAL_ERROR]\n"
" \"message to display\" ...)\n"
- "The arguments are messages to display. If the first argument is "
- "SEND_ERROR then an error is raised. If the first argument is "
- "STATUS then the message is displayed in the progress line for the GUI.";
+ "By default the message is displayed in a pop up window (CMakeSetup), "
+ "or in the stdout of cmake, or the error section of ccmake. "
+ "If the first argument is "
+ "SEND_ERROR then an error is raised, and the generate phase will be "
+ "be skipped. If the first argument is FATAL_ERROR, all processing "
+ "is halted. If the first argument is STATUS then the message is "
+ "displayed in the progress line for the GUI, or with a -- in the "
+ "command line cmake.";
}
cmTypeMacro(cmMessageCommand, cmCommand);