mirror/nasm
2
0
Fork 0
mirror of https://github.com/netwide-assembler/nasm.git synced 2024-11-21 03:14:19 +08:00
Code Issues Packages Projects Releases Wiki Activity
nasm-2.15.xx
nasm/doc/Makefile.in

128 lines
2.7 KiB
Makefile
Raw Permalink Normal View History

NASM 0.98
2002-05-01 04:58:18 +08:00
#
# UNIX Makefile for NASM documentation
#
Makefile portability improvement, build nasmdoc.pdf.xz Significantly improve the portability/reliability of a general make command. Build a .pdf.xz version of the documentation, using an uncompressed pdf as basis. Signed-off-by: H. Peter Anvin (Intel) <hpa@zytor.com>
2020-05-27 05:13:31 +08:00
@SET_MAKE@
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-17 11:30:09 +08:00
top_srcdir = @top_srcdir@
NASM 0.98
2002-05-01 04:58:18 +08:00
srcdir = @srcdir@
VPATH = @srcdir@
prefix = @prefix@
exec_prefix = @exec_prefix@
bindir = @bindir@
mandir = @mandir@
Make buildsystem respect GNU conventions * CPPFLAGS is a user variable and should be respected when compiling .c files. Think of -D_FORTIFY_SOURCE=2. * Pass ALL_CFLAGS when linking too. This is recommended for certain edge cases (-flto) * Use DESTDIR instead of INSTALLROOT for staging dir Every other build system (Automake, CMake, Meson) uses DESTDIR. This integrates better into distro and other build systems that have standard hooks for DESTDIR. * $(MAKE) -C <dir> is better than cd'ing into a <dir> * Use Autoconf's ${docdir} and ${htmldir} for installing the documentation. This makes handling documentation easier and respects user choice. Signed-off-by: David Seifert <soap@gentoo.org> Signed-off-by: Cyrill Gorcunov <gorcunov@gmail.com>
2017-07-02 11:13:56 +08:00
docdir = @docdir@
htmldir = @htmldir@
NASM 0.98
2002-05-01 04:58:18 +08:00
infodir = @infodir@
Suppress datarootdir warnings from configure
2007-10-19 14:33:06 +08:00
datarootdir = @datarootdir@
NASM 0.98
2002-05-01 04:58:18 +08:00
INSTALL = @INSTALL@
INSTALL_PROGRAM = @INSTALL_PROGRAM@
INSTALL_DATA = @INSTALL_DATA@
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-17 11:30:09 +08:00
PERL = perl -I$(srcdir)
doc: for ps to pdf conversion, use "acrodist", "ps2pdf" or "pstopdf" For PostScript to PDF conversion, use whichever of "acrodist", "ps2pdf", or "pstopdf" which we can find on the system. I haven't tried either acrodist or pstopdf myself, only going my the documentation, but prefer acrodist since it is claimed to produce smaller output files than ps2pdf.
2008-06-20 02:39:23 +08:00
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-11 07:10:28 +08:00
PDFOPT = @PDFOPT@
NASM 0.98
2002-05-01 04:58:18 +08:00
Makefile portability improvement, build nasmdoc.pdf.xz Significantly improve the portability/reliability of a general make command. Build a .pdf.xz version of the documentation, using an uncompressed pdf as basis. Signed-off-by: H. Peter Anvin (Intel) <hpa@zytor.com>
2020-05-27 05:13:31 +08:00
MKDIR_P = @MKDIR_P@
msvc: finally make it possible to build the full Windows package Finally make it possible to build the full Windows install package with MSVC tools. Signed-off-by: H. Peter Anvin <hpa@linux.intel.com>
2017-04-07 11:20:04 +08:00
RM_F = rm -f
RM_RF = rm -rf
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-14 12:54:42 +08:00
CP_F = cp -f
Makefile portability improvement, build nasmdoc.pdf.xz Significantly improve the portability/reliability of a general make command. Build a .pdf.xz version of the documentation, using an uncompressed pdf as basis. Signed-off-by: H. Peter Anvin (Intel) <hpa@zytor.com>
2020-05-27 05:13:31 +08:00
CP_UF = cp -uf
# Optional tools
XZ = @XZ@
# Optional targets
XZFILES = @XZFILES@
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-17 14:52:23 +08:00
# Auxiliary files referenced by the HTML files
HTMLAUX = nasmdoc.css local.css nasmlogw.png
msvc: finally make it possible to build the full Windows package Finally make it possible to build the full Windows install package with MSVC tools. Signed-off-by: H. Peter Anvin <hpa@linux.intel.com>
2017-04-07 11:20:04 +08:00
warnings: define warning classes at point of use It is extremely desirable to allow the user fine-grained control of warnings, but this has been complicated by the fact that a warning class has had to be defined in no less than three places (error.h, error.c, nasmdoc.src) before it can be used in source code. Instead, use a script to define these via magic comments at the point of use. This hopefully will encourage creating new classes as needed. Signed-off-by: H. Peter Anvin (Intel) <hpa@zytor.com>
2018-12-14 13:53:31 +08:00
SRCS = nasmdoc.src inslist.src changes.src warnings.src version.src
Makefile portability improvement, build nasmdoc.pdf.xz Significantly improve the portability/reliability of a general make command. Build a .pdf.xz version of the documentation, using an uncompressed pdf as basis. Signed-off-by: H. Peter Anvin (Intel) <hpa@zytor.com>
2020-05-27 05:13:31 +08:00
OUT = html nasmdoc.txt nasmdoc.pdf $(XZFILES)
XZOUT = nasmdoc.pdf.xz
NASM 0.98
2002-05-01 04:58:18 +08:00
Make dependency generation a bit more robust Improve the corner cases where we might end up with bogus dependencies. Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2017-11-07 14:37:37 +08:00
.SUFFIXES:
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 21:35:29 +08:00
.SUFFIXES: .pfa .ph
Makefile portability improvement, build nasmdoc.pdf.xz Significantly improve the portability/reliability of a general make command. Build a .pdf.xz version of the documentation, using an uncompressed pdf as basis. Signed-off-by: H. Peter Anvin (Intel) <hpa@zytor.com>
2020-05-27 05:13:31 +08:00
.PHONY: all xzfiles html clean spotless install
NASM 0.98
2002-05-01 04:58:18 +08:00
all: $(OUT)
Makefile portability improvement, build nasmdoc.pdf.xz Significantly improve the portability/reliability of a general make command. Build a .pdf.xz version of the documentation, using an uncompressed pdf as basis. Signed-off-by: H. Peter Anvin (Intel) <hpa@zytor.com>
2020-05-27 05:13:31 +08:00
xzfiles: $(XZOUT)
doc: update location of insns.dat insns.dat is now in the x86 directory. Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2016-07-07 02:01:12 +08:00
inslist.src: inslist.pl ../x86/insns.dat
$(PERL) $(srcdir)/inslist.pl $(srcdir)/../x86/insns.dat
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-21 13:50:02 +08:00
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-17 14:52:23 +08:00
html: $(HTMLAUX)
Makefile portability improvement, build nasmdoc.pdf.xz Significantly improve the portability/reliability of a general make command. Build a .pdf.xz version of the documentation, using an uncompressed pdf as basis. Signed-off-by: H. Peter Anvin (Intel) <hpa@zytor.com>
2020-05-27 05:13:31 +08:00
$(MKDIR_P) html
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-17 14:52:23 +08:00
for f in $(HTMLAUX); do $(CP_UF) "$(srcdir)/$$f" html/; done
$(MAKE) html/nasmdoc0.html
doc: Makefile fixes missing from previous checkin
2008-06-12 09:38:15 +08:00
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-17 11:30:09 +08:00
RDSRC = $(PERL) $(srcdir)/rdsrc.pl -I$(srcdir)/
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 14:45:57 +08:00
html/nasmdoc0.html: $(SRCS) rdsrc.pl
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 16:50:13 +08:00
$(RM_F) html/*.html
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-07 11:33:39 +08:00
$(RDSRC) -ohtml html nasmdoc.src
NASM 0.98
2002-05-01 04:58:18 +08:00
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 14:45:57 +08:00
nasmdoc.dip: $(SRCS) rdsrc.pl
msvc: finally make it possible to build the full Windows package Finally make it possible to build the full Windows install package with MSVC tools. Signed-off-by: H. Peter Anvin <hpa@linux.intel.com>
2017-04-07 11:20:04 +08:00
$(RDSRC) dip nasmdoc.src
doc: Makefile fixes missing from previous checkin
2008-06-12 09:38:15 +08:00
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 14:45:57 +08:00
nasmdoc.txt: $(SRCS) rdsrc.pl
msvc: finally make it possible to build the full Windows package Finally make it possible to build the full Windows install package with MSVC tools. Signed-off-by: H. Peter Anvin <hpa@linux.intel.com>
2017-04-07 11:20:04 +08:00
$(RDSRC) txt nasmdoc.src
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-17 11:30:09 +08:00
version.src: $(top_srcdir)/version.pl $(top_srcdir)/version
$(PERL) $(top_srcdir)/version.pl docsrc \
< $(top_srcdir)/version > version.src
Support generating PDF using ps2pdf with special annotations in the PostScript output of rdsrc.pl.
2002-05-04 22:16:20 +08:00
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 21:41:13 +08:00
nasmdoc.ps: nasmdoc.dip genps.pl afmmetrics.ph ttfmetrics.ph \
pswidth.ph nasmlogo.eps psfonts.ph head.ps
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 16:38:41 +08:00
$(PERL) $(srcdir)/genps.pl -epsdir "$(srcdir)" \
doc: we really need a Fontmap file It turns out that we need a Fontmap file after all, *and* -I. to make gs find it. Inconsistent results came from stray Fontmap files from previous debug attempts. Now generate both fontpath and Fontmap, and hopefully at least one of them should work. We might, in fact, need both, one for gs to know where the files are and one for gs to know it is allowed to read them. The core problem seems to be that gs will find OTF fonts by its normal discovery mechanisms, but for some reason don't seem to use them unless it can find them in a Fontmap, Font directory, of CIDFont directory. Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2019-10-05 04:09:30 +08:00
-headps $(srcdir)/head.ps \
-fontpath fontpath \
-fontmap Fontmap \
nasmdoc.dip > nasmdoc.ps
Don't remove head.ps by mistake
2002-05-15 05:21:24 +08:00
doc: actually build and propagate fontpath file The machinery was built in, but the option wasn't invoked from the Makefile. Signed-off-by: H. Peter Anvin (Intel) <hpa@zytor.com>
2019-08-07 14:07:44 +08:00
fontpath: nasmdoc.ps
@: Generated by side effect
doc: we really need a Fontmap file It turns out that we need a Fontmap file after all, *and* -I. to make gs find it. Inconsistent results came from stray Fontmap files from previous debug attempts. Now generate both fontpath and Fontmap, and hopefully at least one of them should work. We might, in fact, need both, one for gs to know where the files are and one for gs to know it is allowed to read them. The core problem seems to be that gs will find OTF fonts by its normal discovery mechanisms, but for some reason don't seem to use them unless it can find them in a Fontmap, Font directory, of CIDFont directory. Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2019-10-05 04:09:30 +08:00
Fontmap: nasmdoc.ps
@: Generated by side effect
doc: actually build and propagate fontpath file The machinery was built in, but the option wasn't invoked from the Makefile. Signed-off-by: H. Peter Anvin (Intel) <hpa@zytor.com>
2019-08-07 14:07:44 +08:00
nasmdoc.pdf: nasmdoc.ps pspdf.pl fontpath
Makefile portability improvement, build nasmdoc.pdf.xz Significantly improve the portability/reliability of a general make command. Build a .pdf.xz version of the documentation, using an uncompressed pdf as basis. Signed-off-by: H. Peter Anvin (Intel) <hpa@zytor.com>
2020-05-27 05:13:31 +08:00
$(PERL) $(srcdir)/pspdf.pl \
$(PDFOPT) $< $@ fontpath
nasmdoc-raw.pdf: nasmdoc.ps pspdf.pl fontpath
$(PERL) $(srcdir)/pspdf.pl -nocompress \
$(PDFOPT) $< $@ fontpath
nasmdoc.pdf.xz: nasmdoc-raw.pdf
$(RM_F) $@
$(XZ) -9e < $< > $@
Don't remove head.ps by mistake
2002-05-15 05:21:24 +08:00
NASM 0.98
2002-05-01 04:58:18 +08:00
clean:
msvc: finally make it possible to build the full Windows package Finally make it possible to build the full Windows install package with MSVC tools. Signed-off-by: H. Peter Anvin <hpa@linux.intel.com>
2017-04-07 11:20:04 +08:00
-$(RM_F) *.rtf *.hpj *.texi *.gid *.ipf *.dip
-$(RM_F) *.aux *.cp *.fn *.ky *.pg *.log *.toc *.tp *.vr
doc: we really need a Fontmap file It turns out that we need a Fontmap file after all, *and* -I. to make gs find it. Inconsistent results came from stray Fontmap files from previous debug attempts. Now generate both fontpath and Fontmap, and hopefully at least one of them should work. We might, in fact, need both, one for gs to know where the files are and one for gs to know it is allowed to read them. The core problem seems to be that gs will find OTF fonts by its normal discovery mechanisms, but for some reason don't seem to use them unless it can find them in a Fontmap, Font directory, of CIDFont directory. Signed-off-by: H. Peter Anvin <hpa@zytor.com>
2019-10-05 04:09:30 +08:00
-$(RM_F) inslist.src version.src fontpath Fontmap
Makefile portability improvement, build nasmdoc.pdf.xz Significantly improve the portability/reliability of a general make command. Build a .pdf.xz version of the documentation, using an uncompressed pdf as basis. Signed-off-by: H. Peter Anvin (Intel) <hpa@zytor.com>
2020-05-27 05:13:31 +08:00
-$(RM_F) nasmdoc*.ps nasmdoc-raw.pdf
NASM 0.98
2002-05-01 04:58:18 +08:00
spotless: clean
msvc: finally make it possible to build the full Windows package Finally make it possible to build the full Windows install package with MSVC tools. Signed-off-by: H. Peter Anvin <hpa@linux.intel.com>
2017-04-07 11:20:04 +08:00
-$(RM_RF) html info
Makefile portability improvement, build nasmdoc.pdf.xz Significantly improve the portability/reliability of a general make command. Build a .pdf.xz version of the documentation, using an uncompressed pdf as basis. Signed-off-by: H. Peter Anvin (Intel) <hpa@zytor.com>
2020-05-27 05:13:31 +08:00
-$(RM_F) *.hlp nasmdoc.txt *.inf *.pdf *.pdf.xz *.dvi
NASM 0.98
2002-05-01 04:58:18 +08:00
install: all
Makefile portability improvement, build nasmdoc.pdf.xz Significantly improve the portability/reliability of a general make command. Build a .pdf.xz version of the documentation, using an uncompressed pdf as basis. Signed-off-by: H. Peter Anvin (Intel) <hpa@zytor.com>
2020-05-27 05:13:31 +08:00
$(MKDIR_P) $(DESTDIR)$(htmldir)
Make buildsystem respect GNU conventions * CPPFLAGS is a user variable and should be respected when compiling .c files. Think of -D_FORTIFY_SOURCE=2. * Pass ALL_CFLAGS when linking too. This is recommended for certain edge cases (-flto) * Use DESTDIR instead of INSTALLROOT for staging dir Every other build system (Automake, CMake, Meson) uses DESTDIR. This integrates better into distro and other build systems that have standard hooks for DESTDIR. * $(MAKE) -C <dir> is better than cd'ing into a <dir> * Use Autoconf's ${docdir} and ${htmldir} for installing the documentation. This makes handling documentation easier and respects user choice. Signed-off-by: David Seifert <soap@gentoo.org> Signed-off-by: Cyrill Gorcunov <gorcunov@gmail.com>
2017-07-02 11:13:56 +08:00
$(INSTALL_DATA) html/* $(DESTDIR)$(htmldir)
Makefile portability improvement, build nasmdoc.pdf.xz Significantly improve the portability/reliability of a general make command. Build a .pdf.xz version of the documentation, using an uncompressed pdf as basis. Signed-off-by: H. Peter Anvin (Intel) <hpa@zytor.com>
2020-05-27 05:13:31 +08:00
$(MKDIR_P) $(DESTDIR)$(docdir)
Make buildsystem respect GNU conventions * CPPFLAGS is a user variable and should be respected when compiling .c files. Think of -D_FORTIFY_SOURCE=2. * Pass ALL_CFLAGS when linking too. This is recommended for certain edge cases (-flto) * Use DESTDIR instead of INSTALLROOT for staging dir Every other build system (Automake, CMake, Meson) uses DESTDIR. This integrates better into distro and other build systems that have standard hooks for DESTDIR. * $(MAKE) -C <dir> is better than cd'ing into a <dir> * Use Autoconf's ${docdir} and ${htmldir} for installing the documentation. This makes handling documentation easier and respects user choice. Signed-off-by: David Seifert <soap@gentoo.org> Signed-off-by: Cyrill Gorcunov <gorcunov@gmail.com>
2017-07-02 11:13:56 +08:00
$(INSTALL_DATA) nasmdoc.pdf nasmdoc.txt $(DESTDIR)$(docdir)
Makefile portability improvement, build nasmdoc.pdf.xz Significantly improve the portability/reliability of a general make command. Build a .pdf.xz version of the documentation, using an uncompressed pdf as basis. Signed-off-by: H. Peter Anvin (Intel) <hpa@zytor.com>
2020-05-27 05:13:31 +08:00
#
# Dummy rules that changes make behavior
# (at end to avoid confusing non-GNU makes)
#
.SECONDARY:
.DELETE_ON_ERROR:
Reference in New Issue Copy Permalink