Commit Graph

29 Commits

Author SHA1 Message Date
H. Peter Anvin (Intel)
58a275c3e9 doc/rdsrc.pl: fix unescaped brace
The latest version of Perl complains about an unescaped brace in a
regexp and states that it will be a fatal error in Perl 5.30.  Fix it
now before it becomes a problem.

Signed-off-by: H. Peter Anvin (Intel) <hpa@zytor.com>
2018-06-25 23:13:59 -07:00
H. Peter Anvin
dd47d57e4d doc/rdsrc: don't treat \# as a comment marker if preceeded by \
We need to be able to let \\# represent a literal \#, rather than
be \ followed by a comment.

Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2017-08-16 21:13:23 -07:00
H. Peter Anvin
57e08284a6 doc, html: switch to a columnar layout for a very wide window
If we open in a very wide window, split the text into columns so it
can actually be conveniently read.

Also, change the body margin to 8px, as that seems to be the more
common browser default.

Signed-off-by: H. Peter Anvin <hpa@linux.intel.com>
2017-04-20 18:03:10 -07:00
H. Peter Anvin
aa319b93e9 doc: add the version number to the HTML output
Add the subtitle (e.g. "version XXXX...") to the HTML output.

Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2017-04-17 02:18:50 -07:00
H. Peter Anvin
d31a74e301 doc: add a local.css specifically to be overridden locally
Add a file local.css which is referenced *after* nasmdoc.css, thus
overriding the latter.  This file intentionally has no actual content,
which means it can be overridden locally for any desired content,
e.g. indexing into web fonts or overriding any of the style.

Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2017-04-16 23:52:23 -07:00
H. Peter Anvin
8c81ae0363 doc/rdsrc: make sure HTML tags are properly closed
The last file wouldn't necessarily close all the tags.  Sigh.

Signed-off-by: H. Peter Anvin <hpa@linux.intel.com>
2017-04-14 12:25:10 -07:00
H. Peter Anvin
48e2009f62 doc: in the HTML navbar, be explicit about the target
Show thinks like "Chapter 2" and "Chapter 4" instead of "Previous
Chapter"/"Next Chapter".

Signed-off-by: H. Peter Anvin <hpa@linux.intel.com>
2017-04-14 10:27:13 -07:00
H. Peter Anvin
22fe5b0760 doc: generate proper XHTML for the contents and index
The table of contents and index needed rework to be valid (X)HTML.
The TOC in particular needed some fairly significant rework - it is
supposed to be an ordered list, after all.

Signed-off-by: H. Peter Anvin <hpa@linux.intel.com>
2017-04-14 01:50:13 -07:00
H. Peter Anvin
5194f77bfd doc: add indented paragraphs, valid XHTML, CSS style sheet
Add indented paragraphs, which can be used to continue an item in a
bulleted list.

Produce valid strict XHTML, and include a style sheet with a navbar
and other fancy things.

Remove archaic output formats.  Now only text, XHTML, and PDF are
supported.

Signed-off-by: H. Peter Anvin <hpa@linux.intel.com>
2017-04-13 22:12:05 -07:00
H. Peter Anvin
cb52d49a45 doc: complete removal of unnecessary moves
Make the tool write the output (especially HTML) in a specified
subdirectory directly, and make the tool create the subdirectory if it
doesn't already exists.

Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2017-04-06 20:33:39 -07:00
H. Peter Anvin
841d904f88 perl: change to the new, safer 3-operand form of open()
The 2-operand form was inherently unsafe.  Use the 3-operand form
instead, which guarantees that arbitrary filenames are supported.

This also means we can remove a few instances of sysopen() which was
used for exactly this reason, however, at least in theory sysopen()
isn't portable.

Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2017-04-02 19:36:41 -07:00
H. Peter Anvin
407166001c Fix building in a separate directory from the source code
The code to handle building in a separate directory had seriously
bitrotted.  This contains a number of fixes to make it possible,
including bits like the documentation which never worked in the past.

Signed-off-by: H. Peter Anvin <hpa@linux.intel.com>
2016-05-16 20:30:09 -07:00
H. Peter Anvin
5f0e601f98 doc/rdsrc.pl: escape braces in regular expression to support newer Perl
Newer versions of Perl require literal braces in regular expressions
to be escaped.

Signed-off-by: H. Peter Anvin <hpa@linux.intel.com>
2016-02-18 11:48:12 -08:00
H. Peter Anvin
e6ee1a859b Add copyright verbiage to Perl scripts; update LICENSE
This adds copyright verbiage to the Perl scripts.  Scripts that are
known to be clean w.r.t. the 2-clause BSD license are given that
license; unclear ones are given the "LGPL for now".

Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2009-06-28 16:54:44 -07:00
H. Peter Anvin
2aa72b64a6 rdsrc.pl: handle tabs in the input
It is just to painful to keep the source files tab-free.  Handle tabs
in the input as required.

Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2008-09-30 17:12:19 -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
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
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
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
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
H. Peter Anvin
ebcd6d8b38 Rip out the old PostScript backend and make the new one official. 2002-05-16 18:15:31 +00:00
H. Peter Anvin
e77259caf6 Use em dash for the title 2002-05-14 21:28:54 +00:00
H. Peter Anvin
fe1bdcb23f Produce "dip" -- basically digested paragraphs for standalone backends 2002-05-14 06:05:06 +00:00
H. Peter Anvin
f834c7e4a7 Encode metadata in the documentation source, rather than hard-coding it. 2002-05-14 05:56:18 +00:00
H. Peter Anvin
c936bae6f0 Fix the positioning of the page number in the table of contents 2002-05-07 05:50:14 +00:00
H. Peter Anvin
33a514c196 Support generating PDF using ps2pdf with special annotations in the
PostScript output of rdsrc.pl.
2002-05-04 14:16:20 +00:00
H. Peter Anvin
1cd0e2d5bf NASM 0.98.08 2002-04-30 21:00:33 +00:00
H. Peter Anvin
41bf8002b2 NASM 0.98 2002-04-30 20:58:18 +00:00
H. Peter Anvin
76690a12ad NASM 0.96 2002-04-30 20:52:49 +00:00