3 DOCFILES:=*.texinfo $(ASDFTEXI)
4 TMPTYPES:=aux cp cps fn fns ky log pg toc tp tps vr vrs
5 TMPFILES:=$(foreach target,asdf sbcl,$(foreach type,$(TMPTYPES),$(target).$(type)))
6 PSFILES=sbcl.ps asdf.ps
7 PDFFILES=sbcl.pdf asdf.pdf
8 INFOFILES=sbcl.info asdf.info
9 HTMLDIRS=$(basename $(SBCLTEXI)) $(basename $(ASDFTEXI))
10 HTMLFILES=sbcl.html asdf.html
11 # Place where generated documentation ends up. The value of
12 # DOCSTRINGDIR has to end with a slash or you lose (it's passed to
13 # Lisp's `pathname' function).
14 DOCSTRINGDIR="docstrings/"
15 CONTRIB_SRC_DIR="../../contrib/"
16 CONTRIB_OBJ_DIR="../../obj/asdf-cache/"
17 I_FLAGS=-I $(DOCSTRINGDIR) -I $(CONTRIB_SRC_DIR)
18 # List of contrib modules that docstring docs will be created for.
19 MODULES=':sb-md5 :sb-queue :sb-concurrency :sb-rotate-byte :sb-grovel \
20 :sb-sprof :sb-bsd-sockets :sb-cover :sb-posix'
21 # List of package names that docstring docs will be created for.
22 PACKAGES=":COMMON-LISP :SB-ALIEN :SB-DEBUG :SB-EXT :SB-GRAY :SB-MOP \
23 :SB-PCL :SB-SYS :SB-SEQUENCE \
24 :SB-PROFILE :SB-THREAD :SB-MD5 :SB-QUEUE :SB-ROTATE-BYTE \
25 :SB-SPROF :SB-BSD-SOCKETS :SB-COVER :SB-POSIX :SB-CONCURRENCY"
27 # SBCL_SYSTEM is an optional argument to this make program. If this
28 # variable is set, its contents are used as the command line for
31 # When passing a non-standard SBCL_SYSTEM, be sure to set the
32 # environment variable SBCL_HOME to a useful value, as well.
47 all: asdf.texinfo ps pdf info html
54 ln -s ../../contrib/asdf/asdf.texinfo
56 # html documentation; output in $(HTMLDIRS)
60 html-stamp: $(DOCFILES) docstrings
63 # $(MAKEINFO) $(I_FLAGS) --html --css-include=style-multi.css $(SBCLTEXI)
64 # $(MAKEINFO) --html --css-include=style-multi.css $(ASDFTEXI)
65 $(MAKEINFO) $(I_FLAGS) --html --no-split --css-include=style-single.css $(SBCLTEXI)
66 $(MAKEINFO) --html --no-split --css-include=style-single.css $(ASDFTEXI)
69 # Postscript documentation
77 %.dvi: %.texinfo $(DOCFILES) docstrings
78 texi2dvi $(I_FLAGS) $<
84 %.pdf: %.texinfo $(DOCFILES) docstrings
85 $(TEXI2PDF) $(I_FLAGS) $<
91 %.info: %.texinfo $(DOCFILES) docstrings
92 $(MAKEINFO) $(I_FLAGS) $<
94 # Texinfo docstring snippets
95 # Note: assumes contrib module names are the same as the names of
96 # directories containing the modules, and that these directories
97 # are in $(CONTRIB_OBJ_DIR).
98 CONTRIB_FASLS=$(shell find $(shell echo $(MODULES) | sed "s|:|$(CONTRIB_OBJ_DIR)|g") -name '*.fasl')
99 docstrings: $(CONTRIB_FASLS) tempfiles-stamp
100 for module in $(shell echo $(MODULES)); do \
101 test -f $(CONTRIB_OBJ_DIR)/`echo $$module | tr -d :`/test-passed.test-report \
102 || { echo "The documented contrib $$module seems \
103 to have failed its tests." && exit 1; } \
105 DOCSTRINGDIR=$(DOCSTRINGDIR) \
106 PACKAGES=$(PACKAGES) \
108 sh make-tempfiles.sh "$(SBCL_SYSTEM)" && touch $(DOCSTRINGDIR)
111 touch tempfiles-stamp
115 rm -f *~ *.bak *.orig \#*\# .\#* texput.log *.fasl
116 rm -rf $(HTMLDIRS) $(DOCSTRINGDIR)
118 rm -f contrib-docs.texi-temp
119 rm -f package-locks.texi-temp
120 rm -f variables.texinfo
121 rm -f $(PSFILES) $(PDFFILES) html-stamp tempfiles-stamp
122 rm -f $(TMPFILES) $(INDEXFILES)
123 rm -f sbcl.info sbcl.info-* asdf.info