Commit Graph

251 Commits

Author SHA1 Message Date
H. Peter Anvin
593b73ae6d doc: title capitalization 2008-06-11 18:52:54 -07:00
H. Peter Anvin
7baaf630a5 doc: add missing period. 2008-06-11 18:51:14 -07:00
H. Peter Anvin
57bf27b654 doc: remove obsolete note. 2008-06-11 18:50:41 -07:00
H. Peter Anvin
792ade2256 doc: Makefile fixes missing from previous checkin 2008-06-11 18:38:15 -07:00
H. Peter Anvin
773a513a1d doc: another case of the RTF backend corrupting state
Another case of the RTF backend corrupting global state.  "Fix" it by
only outputting one format at a time; this also makes it possible to
run in parallel.
2008-06-11 18:32:33 -07:00
H. Peter Anvin
62332b2373 doc: ps/pdf: set page numbers in normal-sized italic
Set page numbers in normal-sized italic, instead of large and bold.
We might want to consider using bold italic, but I think this is just
fine.
2008-06-11 18:23:14 -07:00
H. Peter Anvin
eb8db629d0 doc: Add NASMENV to the index (BR 1917084)
Add NASMENV to the documentation index.
2008-06-11 18:14:24 -07:00
H. Peter Anvin
3d61238bf8 ps/pdf doc: default to 10-point font, wider leading
Switch the main font to 10 points Times Roman, but leave the leading
at 11 points.  This produces, in my opinion, a much more legible and
printable document.
2008-06-11 18:09:02 -07:00
H. Peter Anvin
ca5ec7a225 Make -F imply -g (BR 1991213)
When the user specifies -F, imply the -g option.  Too many users seem
to make this mistake.
2008-06-11 18:07:40 -07:00
H. Peter Anvin
7df0417e58 Add %warning, saner unquoting of %error
- Add %warning directive
- Only unquote an %error or %warning string if it is the only thing on
  the directive line.
- Don't expand macros inside a quoted string, even for %error.
2008-06-10 18:27:38 -07:00
H. Peter Anvin
c800e131c1 doc: Fix title "String Constants"
Cut & paste oops...
2008-06-08 16:55:15 -07:00
H. Peter Anvin
cf948a3904 doc: Index Unicode and UTF-8
Add Unicode and UTF-8 to the index
2008-06-08 16:54:03 -07:00
H. Peter Anvin
cb40e8a010 doc: \t is also a supported escape sequence... 2008-06-08 16:50:23 -07:00
H. Peter Anvin
9544bec3f5 doc: s/by/in/ certain preprocessor directives. 2008-06-08 16:49:16 -07:00
H. Peter Anvin
c2734cc43c Split documentation on string syntax out of "character constants"
Split the documentation on string syntax, as a lexical entity, out of
the section about character constants.  It was confusing to have
discussion that apply more to string constants than character
constants, and they use the same syntax anyway.
2008-06-08 16:46:37 -07:00
H. Peter Anvin
062ee976c4 doc: A few floating-point examples 2008-06-08 16:39:28 -07:00
H. Peter Anvin
27bdec9295 doc: add a comma
This time the comma should actually be there.
2008-06-08 16:35:45 -07:00
H. Peter Anvin
6581802f8b doc: ALL %if constructs have %elif/%ifn/%elifn variants.
All %if constructs now have %elif/%ifn/%elifn; this is hard-coded into
the preprocessor.
2008-06-08 16:34:44 -07:00
H. Peter Anvin
868067de66 doc: remove superfluous comma 2008-06-08 16:25:20 -07:00
H. Peter Anvin
66f1d9ffb1 Improve the %iftoken example 2008-06-08 16:24:06 -07:00
H. Peter Anvin
ef0145540e Fix capitalization in titles 2008-06-08 16:20:26 -07:00
Frank Kotler
af19b09a2e Document __OUTPUT_FORMAT__
It may be "too late" for this to get into 2.03, but I've been whining
that "__OUTPUT_FORMAT__" ought to be documented. Maybe...
2008-06-08 10:48:16 -07:00
H. Peter Anvin
533fb7e1f5 doc: Remove superfluous comma. 2008-06-04 17:24:35 -07:00
H. Peter Anvin
9e20016eda Add %defstr, %idefstr
Add %defstr and %idefstr, to define a macro as a quoted string.
2008-06-04 17:23:14 -07:00
H. Peter Anvin
64bd892d7f doc: Remove "what's new" since it is out of date 2008-06-02 18:32:01 -07:00
H. Peter Anvin
e8a092976e Document UTF-8 conversion better, use "byte" instead of "ASCII"
ASCII specifically refers to characters <= 127, so to use "ASCII" for
literal bytes is really confusing in a multibyte environment.  Give an
example of using Unicode escapes.
2008-06-01 23:00:23 -07:00
H. Peter Anvin
677befc461 Document that underscores in numbers is permitted. 2008-06-01 22:53:15 -07:00
H. Peter Anvin
c23b2a9d47 nasmdoc: document %substr, ... 2008-06-01 22:36:09 -07:00
H. Peter Anvin
39fe51eedf Fix bug where the WinHelp backend corrupts the internal data
WinHelp/RTF needs to convert \ to \\, but did so on the global data,
so the DIP output was corrupted.
2008-06-01 22:34:55 -07:00
H. Peter Anvin
311d27d328 doc: Single section for all the date/time macros
Move all the date/time macros to a common section so we can give a
common example.  We don't have support for a fourth level of headers,
so just use a bulleted list.
2008-05-30 14:32:16 -07:00
H. Peter Anvin
7d6fae6537 doc: fix __UTC_DATE__ and __UTC_TIME__ description 2008-05-30 14:11:40 -07:00
H. Peter Anvin
fd59e0c63c Document %pathsearch and %depend 2008-05-30 11:03:56 -07:00
H. Peter Anvin
e63e62be46 doc: consistent capitalization (and indexing!) of INCBIN 2008-05-30 10:09:24 -07:00
H. Peter Anvin
9e1f528c36 Add the -MP option to emit phony targets
Add the -MP option to emit phony targets.  Since this means each
header file has to be visited more than once, change the
implementation to use an internal list of all the dependencies, and
centralize the emission of the dependency files.
2008-05-29 21:38:00 -07:00
H. Peter Anvin
dbd75f7afc Document the new dependency options. 2008-05-29 19:27:05 -07:00
H. Peter Anvin
14b015f9d6 Missing % in %ifmacro 2008-05-28 22:11:13 -07:00
Andy Polyakov
95cd596352 doc: document Win32/64 SEH extensions
Document COFF extensions for Windows SEH
2008-05-27 14:03:09 -07:00
H. Peter Anvin
ca4f36cc2c Document %? and %?? 2008-05-25 22:09:17 -07:00
H. Peter Anvin
e6a5cb536a doc: another reference to DY 2008-05-23 18:24:03 -07:00
H. Peter Anvin
a69749581d Document DY, RESY and YWORD 2008-05-23 17:58:01 -07:00
H. Peter Anvin
21513e822f inslist.pl: deal with the new encoding format
Make it possible for inslist.pl to understand the new encoding format;
fix a few minor buglets.
2008-05-20 18:33:40 -07:00
Charles Crayne
a762ca544b Avoid long line warning when generating nasm docs
rdsrc.pl limits lines to 68 characters for some formats
2008-04-12 13:35:43 -07:00
Charles Crayne
8ca31b48af Document avaiabily of DWARF for ELF32 and ELF64 2008-04-07 14:26:29 -07:00
H. Peter Anvin
134b94665d Add %ifempty and variants 2008-02-16 17:01:40 -08:00
H. Peter Anvin
cbf768d67d Implement %iftoken, test for a single token
Implement %iftoken, a test for a single token.  This is useful in
cases using %+ to splice a macro-provided token.
2008-02-16 16:41:25 -08:00
H. Peter Anvin
8c01b0b409 Use term "host platform" consistently 2008-02-16 14:57:45 -08:00
H. Peter Anvin
70e63c9a9a Add standard time macro boilerplate to __POSIX_TIME__ 2008-02-16 14:56:49 -08:00
H. Peter Anvin
6b18bcce46 BR 774131: date and time macros
This checkin creates the following date and time macros:

__DATE__, __TIME__, __UTC_DATE__, __UTC_TIME__: strings

__DATE_NUM__, __TIME_NUM__, __UTC_DATE_NUM__, __UTC_TIME_NUM__:
civil dates in digit-string formats

__POSIX_TIME__: time in POSIX time_t format
2008-02-16 14:54:10 -08:00
H. Peter Anvin
8960f37b9c doc/Makefile.in: avoid deleting opt_var.txt, fix dependencies
Fix dependencies in the generation of the instruction list, and make
sure we don't delete opt_var.txt on "make spotless".
2008-01-20 21:50:02 -08:00
Charles Crayne
c17a0eb31b Add autogenerated instruction list to NASM documentation
1. Allow included files in rdsrc.pl
2. New program inslist.pl to generate instruction list from insns.dat
3. Mark certain comments in insns.dat as documentation subheaders
4. Add Instruction List appendix to nasmdoc.src
5. Update build process to invoke inslist.pl
2008-01-20 16:27:03 -08:00
Charles Crayne
1727b3d0eb Check in Ed Beroset's documentation fix
Correct count in %strlen example
2007-12-28 15:00:03 -08:00
H. Peter Anvin
e55c836b5a Document naming of registers in 64-bit mode
Intel's docs diverge from AMD's docs (MASM follow AMD's docs);
formally document what we're doing and include a file of macros in
case someone wants to use alternate names.
2007-12-10 15:35:28 -08:00
H. Peter Anvin
5f5a252a36 Refer to version 2.00 consistently as 2.00 not 2.0 2007-11-29 17:30:11 -08:00
H. Peter Anvin
869ed26461 doc: 16- and 128-bit floating point were also new for 2.0 2007-11-29 17:29:37 -08:00
H. Peter Anvin
f7acb2f902 Update install instructions; remove references to nasmw.exe 2007-11-29 17:28:05 -08:00
H. Peter Anvin
72da449a41 doc: s/NASM/nasm/ in invocation example
On case-sensitive systems, "NASM" doesn't work.
2007-11-29 17:20:45 -08:00
H. Peter Anvin
d1e8ba6039 -o is output filename, not output format 2007-11-29 17:19:49 -08:00
H. Peter Anvin
3e30d5aefe Give an example on how Unix and Win64 count argument differently 2007-11-29 17:17:35 -08:00
H. Peter Anvin
52b4d6d7b0 Allow numbers to be sorted separately from letters
Allow numbers to be sorted separately from letters.
2007-11-29 17:10:04 -08:00
H. Peter Anvin
540f903928 nasmdoc.src: editorial changes 2007-11-29 17:07:53 -08:00
H. Peter Anvin
c780557e15 %ixdefine, not %xidefine
The docs had %xidefine, the code has %ixdefine.  The code wins.
2007-11-29 13:10:08 -08:00
Charles Crayne
f2098e9935 Documention Changes for Release 2.00
modified:   CHANGES
	modified:   ChangeLog
	modified:   doc/nasmdoc.src
2007-11-25 14:25:13 -08:00
H. Peter Anvin
21eed86871 Typo fixes in documentation
Typo fixes in documentation, including BR 1836379
2007-11-24 16:31:48 -08:00
H. Peter Anvin
24588d35e7 Remove FIXME from documentation
This better work now, we're in release candidate mode.
2007-11-17 21:21:18 -08:00
Charles Crayne
db90f35d89 Check in Keith's Fixes
1. Don't warn on 32-bit overflow
2. Change EM64T to Intel 64 in Defining CPU Dependencies
   section of documentation.
2007-11-17 21:08:33 -08:00
root
dbb1828ad5 Support setting OSABI value in ELF header. 2007-11-13 19:52:54 -08:00
Charles Crayne
c22ae5cb12 Update documentation for stack relative directives.
Bring a few other sections up to date.
2007-11-10 21:55:19 -08:00
Charles Crayne
9fb030f8cd Update documantation for stack relative directives 2007-11-09 16:37:41 -08:00
Charles Crayne
102cdadb6f Update documentation for stack relative directives 2007-11-09 16:25:43 -08:00
H. Peter Anvin
88602aa53a ps2pdf: remove -dOptimize=true
Remove -dOptimize=true; it actually generates larger output, since the
optimization performed is "network optimization".
2007-11-08 20:29:37 -08:00
H. Peter Anvin
2ce0274303 Use a 32-bit floating-point limb size; support 8-bit float
Use a 32-bit limb size ("like a digit, but bigger") for floating-point
conversion.  This cuts the number of multiplications per constant by a
factor of four.

This means supporting fractional-limb-sized numbers, so while we're at
it, add support for 8-bit floating point numbers (apparently used in
graphics and in audio compression applications.)
2007-10-29 20:20:12 -07:00
Charles Crayne
650dc9d004 Update sections about debug info formats 2007-10-24 15:30:17 -07:00
H. Peter Anvin
7065309739 Formatting: kill off "stealth whitespace"
"Stealth whitespace" makes it harder to read diffs, and just generally
cause unwanted weirdness.  Do a source-wide pass to get rid of it.
2007-10-19 14:42:29 -07:00
Charles Crayne
f3eea3d539 Suppress datarootdir warnings from configure 2007-10-18 23:33:06 -07:00
H. Peter Anvin
f6c9e65d4f Implement floating-point option control directive
New directive [FLOAT] with associated standard macros; allows the
setting to be saved and restored.
2007-10-16 14:40:27 -07:00
H. Peter Anvin
fd7dd11345 Create option -Ox to tell NASM to do unlimited passes
Add option -Ox to tell NASM to do as many passes as it needs, instead
of imposing a fixed number.
2007-10-10 14:06:59 -07:00
H. Peter Anvin
413fb900bf nasm option reshuffling, -E -> -Z
Old -E becomes -Z
New -E is alias for -e
Remove the obsolete -r option
2007-09-26 15:19:28 -07:00
H. Peter Anvin
4cba95cf81 nasmdoc: corrections on 64-bit immediates/displacements
Corrections the section on 64-bit immediates and displacements.  In
particular, immediates are sign-extended the same way displacements
are (and the same way 8-bit immediates are), so there is some use for
the 7-byte mov eax,dword imm form :(
2007-09-25 20:36:45 -07:00
H. Peter Anvin
64b3a9c56b nasmdoc: shorten lines which are too long 2007-09-25 16:02:21 -07:00
H. Peter Anvin
f664bf1ed6 Document NASM behaviour for 64-bit immediates and displacements
Document (intended) NASM behaviour for 64-bit immediates and
displacements.
2007-09-25 16:01:07 -07:00
H. Peter Anvin
ed29882b51 nasmdoc: grammar fix
half -> halves
2007-09-24 13:54:00 -07:00
H. Peter Anvin
1fd23400fd nasmdoc: remove stray periods
A title line doesn't end in a period.
2007-09-24 13:44:02 -07:00
H. Peter Anvin
37a321fbbe Implement the -MG option (SF RFE 1564264)
Implement the -MG option, to generate dependencies in the presence of
generated files.  In the end, we probably need to support the full
gamut of GCC-like dependency-generation options.
2007-09-24 13:41:58 -07:00
H. Peter Anvin
dee8eaa967 nasmdoc: clarify __float*__ example 2007-09-24 12:52:09 -07:00
H. Peter Anvin
ea043ef039 nasmdoc: document the __float*__ operators 2007-09-24 12:44:38 -07:00
H. Peter Anvin
25a993488c BR 1783117: Document that %+ needs a space after it, and fix crash
Document that %+ needs a space after it due to collision with %+1
syntax for multiline macro arguments; make it issue an error message
rather than crashing.
2007-09-22 17:45:45 -07:00
H. Peter Anvin
8084f105a2 Document Infinity and NaN
Add __Infinity__, __QNaN__, and __SNaN__ to the documentation.
2007-09-18 22:08:04 -07:00
H. Peter Anvin
5107d672a0 Update documentation
Document new floating-point capabilities, and clean up the discussion
about BITS 64 and REX prefixes.
2007-09-18 19:12:26 -07:00
H. Peter Anvin
0edc309505 Document oword, do and reso
Document oword and the associated do and reso pseudoinstructions.
2007-09-18 13:45:12 -07:00
H. Peter Anvin
2f3c4c056e Additional documentation for 64-bit programming
Flesh out the documentation for 64-bit programming a little bit; in
particular, include links to the ABI documentation for various
platforms.
2007-09-17 13:03:33 -07:00
H. Peter Anvin
d105682096 Remove $Id$ tags (useless with git)
Remove CVS $Id$ tags, since git doesn't use them.
2007-09-12 21:05:06 -07:00
H. Peter Anvin
9c06db6935 doc: add some cross-references 2007-09-11 23:57:23 +00:00
H. Peter Anvin
9b49e24e1f Feeble attempt at updating the documentation; remove Appendix B
Feeble attempt to document 64-bit support.  Also, remove Appendix B since
we have been utterly useless at keeping it up to date, and it's redundant
with the processor manufacturer's documentation anyway.
2007-09-11 23:52:01 +00:00
Frank Kotler
155eef6a3d finally commit Mike Frysinger's "elf-visibility" patch 2007-08-26 05:10:24 +00:00
Chuck Crayne
b7eea1c940 Addition of elf32 and elf64 output formats.
Addition of ! as unary operator in expression evaluation.
Allow numeric constants in DQ directive.
2007-05-04 02:16:08 +00:00
Keith Kanios
b7a89544d0 General push for x86-64 support, dubbed 0.99.00. 2007-04-12 02:40:54 +00:00
Eric Christopher
1e0de6e913 Fix documentation building for non-srcdir builds. Still bugs in .ps implementation.
Add Mach-O documentation.
2006-02-04 00:23:30 +00:00
Frank Kotler
9d8c22b202 add John Coffman's optimizer documentation 2005-03-10 02:03:11 +00:00
Frank Kotler
c0e34d4f81 Document maximum identifier length 2004-12-31 03:38:32 +00:00
Frank Kotler
6f7a5a60dc Touch up docs 2003-12-12 07:54:15 +00:00