Commit Graph

567 Commits

Author SHA1 Message Date
Cyrill Gorcunov
4c171ce268 doc: Update changes for 2.13.02
Signed-off-by: Cyrill Gorcunov <gorcunov@gmail.com>
2017-11-25 17:41:38 +03:00
H. Peter Anvin
f275ce9c88 doc: update for upcoming 2.13.02 release
Update release notes and documentation for 2.13.02.

Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2017-08-16 22:36:32 -07:00
H. Peter Anvin
427b9cae8b nasm: when using -MW, enclose whitespace in double quotes
When using the -MW option, enclose whitespace-containing filenames in
double quotes.  There are probably quite a few other things we ought
to know how to do...

Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2017-08-16 22:17:51 -07:00
H. Peter Anvin
c2834b9abe nasmdoc: the dbg output format is compiled in by default
These days, the dbg output format is compiled in by default, too.

Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2017-08-16 21:17:27 -07:00
H. Peter Anvin
77c9bf6cd8 nasm: new option -MW to emit Watcom-style Makefile rules
Allow NASM to generate Watcom-style Makefile dependencies, in addition
to the default POSIX-style Makefile dependencies.

Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2017-08-16 21:14:33 -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
4be9b5790d nasmdoc.css: add more space between columns and a column separator
The columns were rather crammed together; add more space around them
and add a column separator bar.

Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2017-05-02 13:09:49 -07:00
H. Peter Anvin
735883692d Document/update dependencies for the documentation
Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2017-05-02 13:01:59 -07:00
H. Peter Anvin
4892f95bb5 doc/changes.src: update with the latest changes
Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2017-05-01 21:16:21 -07:00
H. Peter Anvin
3301ee8a9e doc/changes.src: document the changes to the 2.13 maint branch so far
Current changes scheduled for 2.13.01.

Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2017-05-01 15:41:30 -07:00
H. Peter Anvin
91ac58dc65 changes.src: we managed to implement a few %pragmas before 2.13...
Minor change to the release notes for 2.13: we did end up with a few
actually implemented %pragmas.

Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2017-04-29 13:34:19 -07:00
H. Peter Anvin
0624296834 changes.src: definitely making 2.13 next
About to release 2.13 for real.

Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2017-04-29 13:13:59 -07:00
H. Peter Anvin
752781f2af doc/pspdf.pl: fix spacing
Fix whitespace alignment, no functional change.

Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2017-04-26 00:16:57 -07:00
H. Peter Anvin
e6eb87edc4 win32, doc: fix PDF generation scripts for Windows
Win32::Registry is obsolete, we need to use Win32::TieRegistry on
current platforms.

GhostScript uses # rather than = on Windows, it seems.

Try to find GhostScript in the registry and add it to the PATH.

Signed-off-by: H. Peter Anvin <hpa@linux.intel.com>
2017-04-26 00:05:12 -07:00
H. Peter Anvin
409da5b561 Windows portability: fix construct in findfont.ph, README update
Fix a construct in doc/findfont.ph which crashes Perl on Windows
unconditionally.

Improve the README for building the full package with MSVC.

Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2017-04-25 20:32:39 -07:00
H. Peter Anvin
c6bbfaa70d doc: formatting consistency for %!
Consistent formatting for the %! environment variable reference.

Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2017-04-25 12:39:11 -07:00
H. Peter Anvin
3ddaa86ba2 doc: make the %! (environment variable) construct a little clearer
Make the %! construct a little more clear.

Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2017-04-24 14:21:43 -07:00
H. Peter Anvin
f268b97a8e doc: add (deprecated) to context fall-through lookup heading
Context fall-through lookup is deprecated, make it as clear as
possible.

Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2017-04-24 14:18:59 -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
32b9824f5c doc: formatting fixes to the warnings documentation
Formatting and language consistency cleanups to the sections about
disabling and enabling warning classes.

Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2017-04-20 02:03:59 -07:00
H. Peter Anvin
c2f371c0b9 Merge branch 'master' of ssh://repo.or.cz/nasm 2017-04-20 01:39:42 -07:00
H. Peter Anvin
4d993a1c03 doc: update links to ABI documents
We have a separate namespace for ABI documents.

Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2017-04-20 01:36:57 -07:00
H. Peter Anvin
7e9d4fdf8d nasmdoc.pdf: always begin a chapter on an odd page
If we want to print the document, we really want each chapter to start
on an odd (right-facing) page; otherwise it gets rather strange.

Signed-off-by: H. Peter Anvin <hpa@linux.intel.com>
2017-04-17 16:01:31 -07:00
H. Peter Anvin
cea308b3dc changes.src: document DWARF support for Mach-O
Signed-off-by: H. Peter Anvin <hpa@linux.intel.com>
2017-04-17 14:05:51 -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
984c6011ba doc/genps: make sure we pick up nasmlogo.eps when building cross-dir
When building in a different directory, we still want to make sure we
pick up nasmlogo.eps.

Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2017-04-17 01:38:41 -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
Ed Beroset
74fa0a736a configure.ac, doc/Makefile.in: fix out-of-directory build
Missed some necessary updates.

Signed-off-by: Ed Beroset <beroset@ieee.org>
Signed-off-by: H. Peter Anvin <hpa@linux.intel.com>
2017-04-14 15:28:18 -07:00
H. Peter Anvin
8106a9c2ad nasmdoc.css: no need to go overboard with the yellow highlight...
Make the yellow highlight for the link target a little bit less
bright, so that it is still instantly visible but less immediately
demanding of attention.

Signed-off-by: H. Peter Anvin <hpa@linux.intel.com>
2017-04-14 12:50:17 -07:00
H. Peter Anvin
b4f2409d41 nasmdoc.src: move bug reporting to appendix, mention forums
Move information about the bug reporting to the appendix.  Split
building from source and website/community info into separate
appendices.

Signed-off-by: H. Peter Anvin <hpa@linux.intel.com>
2017-04-14 12:26:16 -07:00
H. Peter Anvin
289f9e4429 nasmdoc.css: highlight the target of an #-link
It is much easier to spot if we get a nice highlight...

Signed-off-by: H. Peter Anvin <hpa@linux.intel.com>
2017-04-14 12:25:43 -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
9a5595ceba nasmdoc.css: specify #-link position in terms of vertical height
Using ems breaks because the header font sizes aren't the same as the
navbar font size.  We could work around that by explicitly specifying
sizes for all of them, but for now, just specify that the link target
should end up 10% below the top of the window.

Signed-off-by: H. Peter Anvin <hpa@linux.intel.com>
2017-04-14 11:31:43 -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
704c2c6b70 nasmdoc.css: adjust the top of #-links
Use a css trick to make sure that the targets of #-links don't end up
underneath the navbar.

Signed-off-by: H. Peter Anvin <hpa@linux.intel.com>
2017-04-14 10:18:39 -07:00
Ed Beroset
d219c55643 configure, doc/Makefile.in: fix out-of-directory build
Fix bit rot for out of directory builds.

Signed-off-by: Ed Beroset <beroset@mindspring.com>
Signed-off-by: H. Peter Anvin <hpa@linux.intel.com>
2017-04-14 09:54:17 -07:00
H. Peter Anvin
ebb8a46386 doc: don't try to install info files we no longer build
No more info files, so don't try to install them...

Signed-off-by: H. Peter Anvin <hpa@linux.intel.com>
2017-04-14 02:55:37 -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
322401fcbc doc: remove obsolete and, quite frankly, condecending information
Remove some highly obsolete and, quite frankly, condecending
introductory content.  For most users, downloading and especially
compiling is no longer an immediate issue, so move that information to
an appendix.

Signed-off-by: H. Peter Anvin <hpa@linux.intel.com>
2017-04-14 00:35:33 -07:00
H. Peter Anvin
d6616be3cf nasmdoc.css: format link better for our needs
The way links are done in the NASM documentation it makes more sense
not to underline them.  Also inhibit coloring for printing.

Signed-off-by: H. Peter Anvin <hpa@linux.intel.com>
2017-04-14 00:02:43 -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
b1778ef7dd doc/genps.pl: move all formatting options to the front
Move all the formatting options to the beginning of the file.

Signed-off-by: H. Peter Anvin <hpa@linux.intel.com>
2017-04-13 17:14:09 -07:00
H. Peter Anvin
f13effec22 doc: add the option to generate an uncompressed PDF
An uncompressed PDF is about twice as big, but if one is using an
external compression program (e.g. .pdf.xz) it compresses far better.
Use it for the RPM specfile.

Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2017-04-10 16:10:28 -07:00
H. Peter Anvin
e8a9041c58 doc/Makefile.in: drop nasmdoc.ps as a usable documentation file
There is no sane reason to use nasmdoc.ps over nasmdoc.pdf since, oh,
about 20 years.  nasmdoc.ps doesn't embed the fonts (and if it did, it
would be very large, whereas nasmdoc.pdf only contains the characters
we explicitly need), and support for PDF is generally much better than
support for PostScript.

It also makes the distribution file smaller to not have two redundant
files.

Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2017-04-10 15:34:59 -07:00
H. Peter Anvin
ceabd83dcf doc: fix fonts where the scale (unitsPerEm) is not 1000
AFM metrics always have 1000 font units to a scaled PostScript point,
but TTF/OTF doesn't have to.  The easiest way (and the one which
best avoids unnecessary rounding) is to store the scale in the
metrics, and change pswidth.ph to return the width in PostScript
points instead of font units.

Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2017-04-10 15:21:04 -07:00
H. Peter Anvin
1ad261f9c9 pspdf.pl: set some better options to ps2pdf (GhostScript)
Generate better PDF files, we hope...

Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2017-04-10 06:47:29 -07:00
H. Peter Anvin
4319b9561d Makefile.in: add ttfmetrics.ph as a dependency
The new module ttfmetrics.ph is a dependency.

Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2017-04-10 06:41:13 -07:00
H. Peter Anvin
70b070f952 doc: improve the look of the documentation with better fonts
Use the Adobe Source Sans/Code Pro fonts by default.  They are Open
Source fonts by Adobe.  However, since these fonts are quite large,
let them be an external dependency and do our best to try to find them
with whatever mechanism is available on the system for finding
standard fonts.

Also have a list of substitution fonts if necessary.

Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2017-04-10 06:35:29 -07:00
H. Peter Anvin
bdbaaa207c doc: clean up the instruction list in the documentation slightly
Compactify the instruction list in the documentation to have fewer
margin violations, and fix some of the headings (;#).

Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2017-04-07 09:51:24 -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