H. Peter Anvin
76fab7ab17
doc: minor edit to the TLS documentation examples.
...
Minimize the TLS documentation examples (we don't need "dword" in a
mov from ebx, for example.) This is just to avoid user confusion.
Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2008-11-02 20:40:16 -08:00
Charles Crayne
81afb49809
Document differences between TLS coding in ELF32 and ELF64
...
Absolute relocation wrt ..tlsie for ELF32
Relative relocation wrt ..gottpoff for ELF64
2008-11-01 17:09:36 -07:00
H. Peter Anvin
8321866bb5
doc: cross-reference macro parameter concatenation with %[...]
...
Explicitly document that %[...] and macro parameters concatenate the
same way, and cross-reference the two.
Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2008-10-29 21:02:30 -07:00
H. Peter Anvin
6c9f6f8e3d
doc: fix typo in the description of %unmacro
...
The description of %unmacro used %unmacro in a place which should
obviously have been %macro.
Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2008-10-29 20:46:30 -07:00
H. Peter Anvin
2d9ceaa3ee
doc: fix capitalization
...
Make the capitalization of "The -t Option" consistent with the other
options.
Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2008-10-29 18:17:59 -07:00
H. Peter Anvin
b7aaf0b9e5
doc: remove duplicate entry for the "error" warning class
...
Remove duplicate entry for the "error" warning class; leave at the end
with "all", as being another meta-warning class.
Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2008-10-29 18:16:31 -07:00
H. Peter Anvin
8a2f145260
doc: retroactively document updates to the warning options
...
Retroactively document the following changes to the warning options:
- gcc-like syntax (-Wfoo, -Wno-foo)
- "all" alias
- "error" metawarning
Added in 2.00rc1 but never documented.
Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2008-10-29 18:14:03 -07:00
Charles Crayne
ee5245a9f2
Initial documentation for ELF64 TLS
...
More to come.
2008-10-27 22:53:40 -07:00
H. Peter Anvin
264b7b982c
preproc: don't macro-expand the argument to %use
...
Use expand_id() for the argument to %use, instead of expand_smacro().
This really makes more sense for a "naked" argument. This is a
semantic change, but is unlikely to break any real code.
Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2008-10-24 16:38:17 -07:00
H. Peter Anvin
0b7d903ec8
doc: document %pop with argument
...
Document that %pop can now take an argument, and what it does.
Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2008-10-24 16:27:11 -07:00
H. Peter Anvin
59c2e54f25
doc: document anonymous %push
...
The anonymous %push was never documented, document it now.
Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2008-10-24 16:19:03 -07:00
H. Peter Anvin
df7d3e22fc
doc: fix awkward word order
...
"the exactly same" -> "exactly the same"
Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2008-10-24 10:15:46 -07:00
H. Peter Anvin
0ca00860df
doc: document the %[...] construct.
...
Add documentation for the %[...] construct.
Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2008-10-19 17:00:52 -07:00
H. Peter Anvin
44d3552ab9
Add reference to %+ from macro parameter concatenation
...
Add a reference to the %+ operator from the section on macro parameter
concatenation.
Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2008-10-15 16:18:17 -07:00
H. Peter Anvin
850ba56f1d
doc: minor editorial change
...
Use the terms "defined" and "expanded" for single-line macros more
consistently.
Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2008-10-15 16:14:39 -07:00
H. Peter Anvin
a3e57106fa
doc: add link to the macro packages when talking about them
...
When discussing the standard macro packages in the context of
__USE_*__ macros, link to them as well as to the %use directive.
Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2008-10-15 11:15:48 -07:00
H. Peter Anvin
d5118f2009
BR 2164053: --prefix _ not --prefix_
...
The --prefix option takes a separate argument, not an attached
argument.
Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2008-10-13 10:17:27 -07:00
H. Peter Anvin
e232d9a6bf
doc: remove tab
...
The documentation processor doesn't like tabs.
Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2008-09-30 17:07:14 -07:00
H. Peter Anvin
2f16043879
Allow %warning output to be suppressed
...
Allow the user to suppress user-specified warnings.
Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2008-09-30 16:39:17 -07:00
H. Peter Anvin
dc0bf47feb
Document the -O0 and -O1 behaviors.
...
Document the way the -O0 and -O1 options actually behave. -O0, in
particular, is NASM 0.98 compatibility mode.
Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2008-09-30 16:24:47 -07:00
Charles Crayne
3cc2459944
Document a64 and o64 qualifiers
...
Add references and index entries for a64 and o64.
2008-09-26 17:13:09 -07:00
H. Peter Anvin
61f130f4e9
Set __PASS__ to 3 for preprocess only
...
When running the preprocessor only, set __PASS__ to 3.
Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2008-09-25 15:45:06 -07:00
H. Peter Anvin
010aee270f
Document __PASS__
...
Document __PASS__, but discourage users from using it.
Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2008-09-24 17:34:37 -07:00
H. Peter Anvin
314b5f9a12
nasmdoc.src: more consistent indentation in %error section
...
We had different indentation levels only two paragraphs apart.
Overall, the document is horribly inconsistent about indentation,
which should be fixed.
2008-09-24 08:46:50 -07:00
H. Peter Anvin
8e3f75ea6e
%error, %warning out on the final pass, add %fatal
...
Only process %error or %warning directives on the final pass. Add a
new %fatal directive which terminates assembly immediately.
2008-09-24 00:21:58 -07:00
H. Peter Anvin
233c4945b1
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>
2008-09-10 23:34:39 -07:00
H. Peter Anvin
1dc23a1b39
doc: Call %xdefine a "resolving define" instead of "enhancing define"
...
%xdefine is an early-binding %define (%define being late-binding.)
There is nothing "enhanced" about it, it just specifies a different
policy. Call it a "resolving define" instead.
Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2008-09-10 23:29:45 -07:00
H. Peter Anvin
3f85cfc766
doc: clean up formatting around -O option
...
Clean up the formatting in descriptions of the -O option.
Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2008-09-10 23:27:10 -07:00
Charles Crayne
2581c869b1
Decouple forward references from optimization
...
Users who wish to control the level of optimization can
continue to specify -O0, -O1, or -Ox,
where x can be the letter itself, or any number > 1.
However, even with optimization turned off,
NASM will always make enough passes to resolve
forward references. As a result, INCBIN is now the only
item left in the critical expressions list, although TIMES
still has its own constant value check.
2008-09-10 19:21:52 -07:00
H. Peter Anvin
39e9a5f72f
Document %use smartalign
2008-09-03 15:03:20 -07:00
H. Peter Anvin
4a532bc707
Document %unmacro
2008-09-03 14:31:20 -07:00
Victor van den Elzen
22343c2c72
Add macro-defaults warning class and documentation.
2008-08-06 14:48:55 +02:00
Victor van den Elzen
0e857f1fe5
Improve checking and documentation for %ifctx
2008-07-23 13:21:29 +02:00
Victor van den Elzen
819703afce
Fix multipass inline warning (dis/en)abling
...
Also add a new form: resetting warnings to their original value.
2008-07-16 15:20:56 +02:00
H. Peter Anvin
04156cd099
Move the revision history into the documentation
...
Clumsily convert the revision history to nasmdoc format, so it can be
included in the documentation as Appendix C.
2008-07-14 02:45:57 -04:00
H. Peter Anvin
cf6b43476e
doc: document packed BCD constants
2008-07-13 15:55:55 -07:00
H. Peter Anvin
bbf769df01
doc: update NASM Version Macros
...
Clean up and slightly update the section on NASM version macros.
2008-07-13 15:44:25 -07:00
H. Peter Anvin
6621073059
doc: move %error/%warning to a separate section
...
They don't really belong in the section on conditional assembly.
2008-07-13 15:41:36 -07:00
H. Peter Anvin
31b98f5431
doc: Document %strcat
2008-07-13 15:35:07 -07:00
H. Peter Anvin
f4ae5ad11b
Protect %use from multi-inclusion and provide a test macro
...
Automatically provide an include guard for %use packages; the macro
__USE_package__ is automatically defined, and inclusion is suppressed
if it is already defined.
2008-06-19 18:39:24 -07:00
H. Peter Anvin
5f9f4007ff
doc: framework for documenting standard macro packages
...
Add a framework for documenting the standard macro packages. Also
move the standard macros to the end of the preprocessor section,
instead of having them in the middle of the directives list.
2008-06-19 16:58:05 -07:00
H. Peter Anvin
1794876088
Merge branch 'nasm-2.03.x'
...
Conflicts:
doc/nasmdoc.src
2008-06-15 21:27:30 -07:00
H. Peter Anvin
04e225ccef
Make -F imply -g (BR 1991213)
...
When the user specifies -F, imply the -g option. Too many users seem
to make this mistake.
Conflicts:
doc/nasmdoc.src
2008-06-15 21:25:56 -07:00
H. Peter Anvin
d11c48d910
Merge branch 'nasm-2.03.x'
...
Conflicts:
doc/nasmdoc.src
2008-06-15 21:22:40 -07:00
H. Peter Anvin
eafc83fc65
doc: Nasm -> NASM
...
Consistently write NASM in all capitals
2008-06-15 21:21:07 -07:00
H. Peter Anvin
1b18ece43c
doc: title capitalization
2008-06-15 21:20:59 -07:00
H. Peter Anvin
f83781db62
doc: add missing period.
...
Conflicts:
2008-06-15 21:20:45 -07:00
H. Peter Anvin
a43569cb9b
doc: Add NASMENV to the index (BR 1917084)
...
Add NASMENV to the documentation index.
2008-06-15 21:18:01 -07:00
H. Peter Anvin
9fea5c4f30
doc: Add Unicode Strings to Unicode index
2008-06-14 21:23:39 -07:00
H. Peter Anvin
5c657bdc12
Document __utf16__ and __utf32__
2008-06-14 21:21:17 -07:00