message.rst 1.2 KB

123456789101112131415161718192021222324252627282930313233
  1. message
  2. -------
  3. Display a message to the user.
  4. ::
  5. message([<mode>] "message to display" ...)
  6. The optional ``<mode>`` keyword determines the type of message:
  7. ::
  8. (none) = Important information
  9. STATUS = Incidental information
  10. WARNING = CMake Warning, continue processing
  11. AUTHOR_WARNING = CMake Warning (dev), continue processing
  12. SEND_ERROR = CMake Error, continue processing,
  13. but skip generation
  14. FATAL_ERROR = CMake Error, stop processing and generation
  15. DEPRECATION = CMake Deprecation Error or Warning if variable
  16. CMAKE_ERROR_DEPRECATED or CMAKE_WARN_DEPRECATED
  17. is enabled, respectively, else no message.
  18. The CMake command-line tool displays STATUS messages on stdout and all
  19. other message types on stderr. The CMake GUI displays all messages in
  20. its log area. The interactive dialogs (ccmake and CMakeSetup) show
  21. STATUS messages one at a time on a status line and other messages in
  22. interactive pop-up boxes.
  23. CMake Warning and Error message text displays using a simple markup
  24. language. Non-indented text is formatted in line-wrapped paragraphs
  25. delimited by newlines. Indented text is considered pre-formatted.