summaryrefslogtreecommitdiff
path: root/Source/cmMessageCommand.h
diff options
context:
space:
mode:
authorStephen Kelly <steveire@gmail.com>2013-09-17 18:54:34 +0200
committerStephen Kelly <steveire@gmail.com>2013-10-08 18:11:22 +0200
commit509c142a3f5ae4c1aa8dfcb4257c63a9e1edc270 (patch)
treea40f496e40a0d6175e5b6c553ab5c3c004a4bba8 /Source/cmMessageCommand.h
parent40c84683aafc9447a0e17d81a71d061efde84bdb (diff)
downloadcmake-509c142a3f5ae4c1aa8dfcb4257c63a9e1edc270.tar.gz
message: Add a DEPRECATION mode
By default, the message is not issued. If CMAKE_ERROR_DEPRECATED is on, the message is fatal. If CMAKE_WARN_DEPRECATED is on, the message is a warning.
Diffstat (limited to 'Source/cmMessageCommand.h')
-rw-r--r--Source/cmMessageCommand.h8
1 files changed, 5 insertions, 3 deletions
diff --git a/Source/cmMessageCommand.h b/Source/cmMessageCommand.h
index fc61810c34..a053bdd790 100644
--- a/Source/cmMessageCommand.h
+++ b/Source/cmMessageCommand.h
@@ -60,9 +60,8 @@ public:
virtual const char* GetFullDocumentation() const
{
return
- " message([STATUS|WARNING|AUTHOR_WARNING|FATAL_ERROR|SEND_ERROR]\n"
- " \"message to display\" ...)\n"
- "The optional keyword determines the type of message:\n"
+ " message([<mode>] \"message to display\" ...)\n"
+ "The optional <mode> keyword determines the type of message:\n"
" (none) = Important information\n"
" STATUS = Incidental information\n"
" WARNING = CMake Warning, continue processing\n"
@@ -70,6 +69,9 @@ public:
" SEND_ERROR = CMake Error, continue processing,\n"
" but skip generation\n"
" FATAL_ERROR = CMake Error, stop processing and generation\n"
+ " DEPRECATION = CMake Deprecation Error or Warning if variable\n"
+ " CMAKE_ERROR_DEPRECATED or CMAKE_WARN_DEPRECATED\n"
+ " is enabled, respectively, else no message.\n"
"The CMake command-line tool displays STATUS messages on stdout "
"and all other message types on stderr. "
"The CMake GUI displays all messages in its log area. "