X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fmanual%2FMakefile;h=cce22045e2c615f09c289c8d10abfaf803b6527b;hb=8a8a8922802460741d6f8f6c11d71b1f414cf3a7;hp=f3f5c5a10c99a8e9c489c71438cf0ded4023a2b8;hpb=3ff0ba49f86506cd5ad6d5d259fa85a40d83fcb2;p=sbcl.git diff --git a/doc/manual/Makefile b/doc/manual/Makefile index f3f5c5a..cce2204 100644 --- a/doc/manual/Makefile +++ b/doc/manual/Makefile @@ -1,14 +1,23 @@ - -DOCFILES:=$(shell echo *.texinfo) -ROOTFILE:=sbcl.texinfo -TMPFILES:=sbcl.aux sbcl.cp sbcl.fn sbcl.ky sbcl.log sbcl.pg sbcl.toc sbcl.tp sbcl.vr - -PSFILE=sbcl.ps -PDFFILE=sbcl.pdf -DVIFILE=sbcl.dvi -INFOFILE=sbcl.info -HTMLDIR=sbcl - +SBCLTEXI:=sbcl.texinfo +ASDFTEXI:=asdf.texinfo +DOCFILES:=*.texinfo $(ASDFTEXI) +TMPTYPES:=aux cps fns ky log pg toc tps vrs +TMPFILES:=$(foreach target,asdf sbcl,$(foreach type,$(TMPTYPES),$(target).$(type))) +PSFILES=sbcl.ps asdf.ps +PDFFILES=sbcl.pdf asdf.pdf +INFOFILES=sbcl.info asdf.info +VARSFILE=variables.template +HTMLDIRS=$(basename $(SBCLTEXI)) $(basename $(ASDFTEXI)) +# Place where generated documentation ends up. The value of +# DOCSTRINGDIR has to end with a slash or you lose (it's passed to +# Lisp's `pathname' function). +DOCSTRINGDIR="docstrings/" +I_FLAGS=-I $(DOCSTRINGDIR) -I ../../contrib/ +# List of contrib modules that docstring docs will be created for. +# FIXME: should check test-passed and not load them. +MODULES=':sb-md5 :sb-rotate-byte :sb-grovel :sb-sprof :sb-bsd-sockets' +# List of package names that docstring docs will be created for. +PACKAGES=":COMMON-LISP :SB-ALIEN :SB-DEBUG :SB-EXT :SB-GRAY :SB-MOP :SB-PROFILE :SB-THREAD :SB-MD5 :SB-ROTATE-BYTE :SB-SPROF :SB-BSD-SOCKETS" ifeq ($(MAKEINFO),) MAKEINFO:=makeinfo @@ -23,53 +32,68 @@ ifeq ($(DVIPS),) endif .PHONY: all -all: ps pdf info html +all: asdf.texinfo ps pdf info html .PHONY: dist dist: html pdf +asdf.texinfo: + rm -f asdf.texinfo + ln -s ../../contrib/asdf/asdf.texinfo +variables: ${VARSFILE} + ./extract-values.sh < ${VARSFILE} >variables.texinfo - +# html documentation; output in $(HTMLDIRS) .PHONY: html html: html-stamp -html-stamp: $(DOCFILES) - @rm -rf $(HTMLDIR) - $(MAKEINFO) --html $(ROOTFILE) +html-stamp: variables $(DOCFILES) docstrings + @rm -rf $(HTMLDIRS) + $(MAKEINFO) $(I_FLAGS) --html $(SBCLTEXI) + $(MAKEINFO) --html $(ASDFTEXI) touch html-stamp - +# Postscript documentation .PHONY: ps -ps: $(PSFILE) +ps: $(PSFILES) -$(PSFILE): $(DVIFILE) +%.ps: %.dvi dvips -o $@ $< -$(DVIFILE): $(DOCFILES) - texi2dvi $(ROOTFILE) - +# DVI generation +%.dvi: %.texinfo variables $(DOCFILES) docstrings + texi2dvi $(I_FLAGS) $< +# PDF documentation .PHONY: pdf -pdf: $(PDFFILE) - -$(PDFFILE): $(DOCFILES) - texi2pdf $(ROOTFILE) +pdf: $(PDFFILES) +%.pdf: %.texinfo variables $(DOCFILES) docstrings + texi2pdf $(I_FLAGS) $< +# info docfiles .PHONY: info -info: $(INFOFILE) +info: $(INFOFILES) + +%.info: %.texinfo variables $(DOCFILES) docstrings + $(MAKEINFO) $(I_FLAGS) $< -$(INFOFILE): $(DOCFILES) - $(MAKEINFO) $(ROOTFILE) +# Texinfo docstring snippets +.PHONY: docstrings +docstrings: tempfiles-stamp +tempfiles-stamp: + DOCSTRINGDIR=$(DOCSTRINGDIR) PACKAGES=$(PACKAGES) MODULES=$(MODULES) sh make-tempfiles.sh && touch tempfiles-stamp .PHONY: clean clean: - rm -f *~ *.bak *.orig \#*\# .\#* texput.log - rm -rf $(HTMLDIR) - rm -f $(PSFILE) $(PDFFILE) $(DVIFILE) html-stamp + rm -f *~ *.bak *.orig \#*\# .\#* texput.log *.fasl + rm -rf $(HTMLDIRS) $(DOCSTRINGDIR) + rm -f contrib-docs.texi-temp + rm -f package-locks.texi-temp + rm -f $(PSFILE) $(PDFFILE) $(DVIFILE) html-stamp tempfiles-stamp rm -f $(TMPFILES) rm -f sbcl.info sbcl.info-*