summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorH. Peter Anvin <hpa@zytor.com>2008-09-10 23:34:39 -0700
committerH. Peter Anvin <hpa@zytor.com>2008-09-10 23:34:39 -0700
commit233c4945b1e4e78c5a9efed9d0ce196805e12af0 (patch)
treedcaf893fe11a383300857d2aac43e6f3f3cedc95 /doc
parent1dc23a1b397222d81165a20f93fde97c43ec2a65 (diff)
downloadnasm-233c4945b1e4e78c5a9efed9d0ce196805e12af0.tar.gz
nasm-233c4945b1e4e78c5a9efed9d0ce196805e12af0.tar.bz2
nasm-233c4945b1e4e78c5a9efed9d0ce196805e12af0.zip
doc: document the use of macros in %error
Document the use of macros in %error and %warning, valid since 2.03. Signed-off-by: H. Peter Anvin <hpa@zytor.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/nasmdoc.src9
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/nasmdoc.src b/doc/nasmdoc.src
index 964b6f4..ffd416a 100644
--- a/doc/nasmdoc.src
+++ b/doc/nasmdoc.src
@@ -3421,7 +3421,14 @@ Similarly, \c{%warning} issues a warning, but allows assembly to continue:
\c %endif
It is optional for the message string after \c{%error} or \c{%warning}
-to be quoted.
+to be quoted. If it is \e{not}, then single-line macros are expanded
+in it, which can be used to display more information to the user. For
+example:
+
+\c %if foo > 64
+\c %assign foo_over foo-64
+\c %error foo is foo_over bytes too large
+\c %endif
\H{otherpreproc} \i{Other Preprocessor Directives}