From: Pascal de Bruijn <pmjdebruijn@pcode.nl>
Date: Thu, 20 Jul 2017 16:13:39 +0000 (+0200)
Subject: pragma: add minimalist message pragma documentation
X-Git-Tag: V2.17~114^2
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=refs%2Fpull%2F462%2Fhead;p=cc65

pragma: add minimalist message pragma documentation

documents 6e93c1ba7332c55eb2067d7be6d20050912ef27d
---

diff --git a/doc/cc65.sgml b/doc/cc65.sgml
index 3689c0b35..cd94f50ac 100644
--- a/doc/cc65.sgml
+++ b/doc/cc65.sgml
@@ -1119,6 +1119,23 @@ parameter with the <tt/#pragma/.
   remembered and output as a whole when translation is finished.
 
 
+<sect1><tt>#pragma message (&lt;message&gt;)</tt><label id="pragma-message"><p>
+
+  This pragma is used to display informational messages at compile-time.
+
+  The message intented to be displayed must be a string literal.
+
+  Example:
+  <tscreen><verb>
+        #pragma message ("in a bottle")
+  </verb></tscreen>
+
+  Results in the compiler outputting the following to stderr:
+  <tscreen><verb>
+        example.c(42): Note: in a bottle
+  </verb></tscreen>
+
+
 <sect1><tt>#pragma optimize ([push,] on|off)</tt><label id="pragma-optimize"><p>
 
   Switch optimization on or off. If the argument is "off", optimization is