nasm/doc
H. Peter Anvin (Intel) 63abf28933 doc/source.src: remove note about "make warnings"
The idea of embedded warning documentation text in the source code was
a cute idea, but the resulting build dependency mess really made it
more painful than it was worth.

The warning declarations were moved to asm/warnings.dat quite a while
ago; remove stray note in the documentation.

Signed-off-by: H. Peter Anvin (Intel) <hpa@zytor.com>
2026-07-07 15:43:40 -07:00
..
16bit.src doc: "MS-DOS" isn't a literal keyword, don't use \c{} 2025-09-29 17:26:17 -07:00
32bit.src doc: Fix missing index tag 2025-09-26 22:12:40 +02:00
64bit.src Merge remote-tracking branch 'jperrett256/jdp-doc-edits' 2025-10-03 10:19:32 -07:00
afmmetrics.ph treewide: replace verbose copyright headers with SPDX tags 2025-10-01 11:45:31 -07:00
changelog.src doc: break the documentation into chapters 2024-08-13 15:55:37 -07:00
changes.src listing: add __?LIST_OPTIONS?__ and __?LIST_OPTIONS_DEFAULT?__ macros 2026-06-28 20:13:30 -07:00
contact.src doc: tweaks to the index 2025-09-05 17:51:38 -07:00
directiv.src doc/directiv.src: fix missing ] in prefix/suffix documentation 2025-10-09 17:29:00 -07:00
findfont.ph treewide: replace verbose copyright headers with SPDX tags 2025-10-01 11:45:31 -07:00
genps.pl treewide: replace verbose copyright headers with SPDX tags 2025-10-01 11:45:31 -07:00
head.ps doc: actually *use* the smaller code font size... 2020-06-27 23:10:50 -07:00
index.src listing: allow the user to suppress abbreviation of TIMES and INCBIN 2026-06-28 18:11:40 -07:00
inslist.pl treewide: replace verbose copyright headers with SPDX tags 2025-10-01 11:45:31 -07:00
inslist.src doc: break the documentation into chapters 2024-08-13 15:55:37 -07:00
internal.doc Better explanation why insnsa.c is a separate module 2002-05-25 01:39:12 +00:00
intro.src doc: tweaks to the index 2025-09-05 17:51:38 -07:00
lang.src outcoff.c: dd symbol wrt ..symtab 2026-06-07 20:05:20 -07:00
local.css doc: add a local.css specifically to be overridden locally 2017-04-16 23:52:23 -07:00
macropkg.src Merge remote-tracking branch 'jperrett256/jdp-doc-edits' 2025-10-03 10:19:32 -07:00
Makefile.in build: only use @SET_MAKE@ in the top-level Makefile.in 2026-07-07 15:26:53 -07:00
mixsize.src doc: break the documentation into chapters 2024-08-13 15:55:37 -07:00
nasmdoc.css nasmdoc.css: make columns wider, smaller text in Appendix F 2025-10-04 16:25:21 -07:00
nasmdoc.src treewide: replace verbose copyright headers with SPDX tags 2025-10-01 11:45:31 -07:00
nasmlogo.eps doc: New NASM logo 2012-02-25 14:53:34 -08:00
nasmlogw.png doc: add indented paragraphs, valid XHTML, CSS style sheet 2017-04-13 22:12:05 -07:00
ndisasm.src Fix confusion between "postfix" and "suffix" 2025-10-07 10:49:55 -07:00
opt_var.txt Fix some typos 2022-01-09 17:34:35 +01:00
outfmt.src doc/outfmt.src: Documented 'function' win32/64 symbol type. 2026-06-07 20:10:15 -07:00
preproc.src listing: allow the user to suppress abbreviation of TIMES and INCBIN 2026-06-28 18:11:40 -07:00
psfonts.ph doc: switch from Adobe Source to Google Roboto 2025-09-29 18:52:01 -07:00
pspdf.pl doc/pspdf.pl: fix Ghostscript executable path construction on Windows 2026-07-07 15:26:53 -07:00
pswidth.ph doc: fix fonts where the scale (unitsPerEm) is not 1000 2017-04-10 15:21:04 -07:00
rdsrc.pl doc/rdsrc.pl: fix output file comment 2025-10-02 17:37:39 -07:00
README doc: switch from Adobe Source to Google Roboto 2025-09-29 18:52:01 -07:00
running.src doc: fix the example for saving and restoring list options 2026-06-29 07:10:26 -07:00
source.src doc/source.src: remove note about "make warnings" 2026-07-07 15:43:40 -07:00
stdmac.src listing: add __?LIST_OPTIONS?__ and __?LIST_OPTIONS_DEFAULT?__ macros 2026-06-28 20:13:30 -07:00
syntax.src doc: fix spelling of "syntactically" 2026-06-25 15:02:58 -07:00
trouble.src doc: break the documentation into chapters 2024-08-13 15:55:37 -07:00
ttfmetrics.ph doc: fix fonts where the scale (unitsPerEm) is not 1000 2017-04-10 15:21:04 -07:00
warn.src doc: break the documentation into chapters 2024-08-13 15:55:37 -07:00

To build the entire documentation, the following tools are needed:

1. A Perl interpreter for your platform
2. The following Perl modules available from CPAN:
   Font::TTF
   Sort::Versions
3. asciidoc
   http://asciidoc.org/
4. xmlto
   https://fedorahosted.org/xmlto
5. One of:
	Adobe Acrobat (acrodist)
	Ghostscript (ps2pdf) http://download.ghostscript.com/
	pstopdf	(available on some BSD-derived Unix systems)

	Of these, Ghostscript is the most tested, although Acrobat has
	been claimed to generate smaller files.
6. For best results, the Google Roboto and Roboto Mono fonts,
   available for free at: https://github.com/googlefonts/