Added documentation for -X command line switch which allows the user to
authorEd Beroset <beroset@mindspring.com>
Sun, 9 Jun 2002 23:22:25 +0000 (23:22 +0000)
committerEd Beroset <beroset@mindspring.com>
Sun, 9 Jun 2002 23:22:25 +0000 (23:22 +0000)
specify the desired error reporting output format.

doc/nasmdoc.src

index 7fd724a..2ac98c3 100644 (file)
@@ -535,6 +535,35 @@ format.
 See \k{opt-F} for more information.
 
 
+\S{opt-X} The \i\c{-X} Option: Selecting an \i{Error Reporting Format}
+
+This option can be used to select an error reporting format for any 
+error messages that might be produced by NASM.
+
+Currently, two error reporting formats may be selected.  They are
+the \c{-Xvc} option and the \c{-Xgnu} option.  The GNU format is 
+the default and looks like this:
+
+\c filename.asm:65: error:specific error message 
+
+
+where \c{filename.asm} is the name of the source file in which the
+error was detected, \c{65} is the source file line number on which 
+the error was detected, \c{error} is the severity of the error (this
+could be \c{warning}), and \c{specific error message} is a more
+detailed text message which should help pinpoint the exact problem.
+
+The other format, specified by \c{-Xvc} is the style used by Microsoft
+Visual C++ and some other programs.  It looks like this:
+
+\c filename.asm(65) error:specific error message
+
+
+where the only difference is that the line number is in parentheses
+instead of being delimited by colons.  
+
+See also the \c{Visual C++} output format, \k{win32fmt}.
+
 \S{opt-E} The \i\c{-E} Option: Send Errors to a File
 
 Under \I{DOS}\c{MS-DOS} it can be difficult (though there are ways) to