## Process this with automake to create Makefile.in
-SUBDIRS = vorbisfile vorbisenc
+SUBDIRS = libvorbis vorbisfile vorbisenc
docdir = $(datadir)/doc/$(PACKAGE)-$(VERSION)
### all of the static docs, commited to SVN and included as is
static_docs = \
- draft-kerr-avt-vorbis-rtp-03.txt \
+ rfc5215.xml \
+ rfc5215.txt \
eightphase.png \
- evenlsp.png \
+ fish_xiph_org.png \
floor1_inverse_dB_table.html \
floorval.png \
fourphase.png \
framing.html \
helper.html \
index.html \
- lspmap.png \
- oddlsp.png \
oggstream.html \
programming.html \
squarepolar.png \
v-comment.html \
vorbis-clip.txt \
vorbis-errors.txt \
- vorbis-fidelity.html \
- vorbis.html \
- vorbisword2.png \
- wait.png \
- white-ogg.png \
- white-xifish.png
-
-### FIXME: bits needed by the spec which lives in xml
+ vorbis-fidelity.html
+
+# bits needed by the spec
SPEC_PNG = \
components.png \
floor1-1.png \
hufftree-under.png \
residue-pack.png \
residue2.png \
- white-xifish.png \
window1.png \
- window2.png
-SPEC_PDF = xifish.pdf
-
-# FIXME: also needed here
-# white-xifish.png
-
-built_docs = Vorbis_I_spec.html Vorbis_I_spec.pdf
+ window2.png \
+ Vorbis_I_spec0x.png \
+ Vorbis_I_spec1x.png \
+ Vorbis_I_spec2x.png \
+ Vorbis_I_spec3x.png \
+ Vorbis_I_spec4x.png \
+ Vorbis_I_spec5x.png \
+ Vorbis_I_spec6x.png \
+ Vorbis_I_spec7x.png \
+ Vorbis_I_spec8x.png \
+ Vorbis_I_spec9x.png \
+ Vorbis_I_spec10x.png \
+ Vorbis_I_spec11x.png \
+ Vorbis_I_spec12x.png \
+ Vorbis_I_spec13x.png \
+ Vorbis_I_spec14x.png
+
+SPEC_TEX = \
+ Vorbis_I_spec.tex \
+ 01-introduction.tex \
+ 02-bitpacking.tex \
+ 03-codebook.tex \
+ 04-codec.tex \
+ 05-comment.tex \
+ 06-floor0.tex \
+ 07-floor1.tex \
+ 08-residue.tex \
+ 09-helper.tex \
+ 10-tables.tex \
+ a1-encapsulation-ogg.tex \
+ a2-encapsulation-rtp.tex \
+ footer.tex
+
+built_docs = Vorbis_I_spec.pdf Vorbis_I_spec.html Vorbis_I_spec.css
# conditionally make the generated documentation
if BUILD_DOCS
-doc_DATA = $(static_docs) $(SPEC_PNG) $(built_docs)
+doc_DATA = $(static_docs) $(SPEC_PNG) $(built_docs) doxygen-build.stamp
else
-doc_DATA = $(static_docs) $(SPEC_PNG)
+doc_DATA = $(static_docs) doxygen-build.stamp
endif
-EXTRA_DIST = $(static_docs) $(doc_sources) \
- $(SPEC_PNG) $(SPEC_PDF) $(built_docs)
-
-doc_sources = xml/Vorbis_I_spec.xml \
- xml/01-introduction.xml \
- xml/02-bitpacking.xml \
- xml/03-codebook.xml \
- xml/04-codec.xml \
- xml/05-comment.xml \
- xml/06-floor0.xml \
- xml/07-floor1.xml \
- xml/08-residue.xml \
- xml/09-helper.xml \
- xml/10-tables.xml \
- xml/a1-encapsulation_ogg.xml \
- xml/a2-encapsulation_rtp.xml \
- xml/footer.xml \
- xml/spec-common.xsl \
- xml/spec-fo.xsl \
- xml/spec-html.xsl
+EXTRA_DIST = $(static_docs) $(built_docs) \
+ $(SPEC_TEX) $(SPEC_PNG) $(SPEC_PDF) Vorbis_I_spec.cfg Doxyfile.in
# these are expensive; only remove if we have to
+MAINTAINERCLEANFILES = $(built_docs)
+CLEANFILES = $(SPEC_TEX:%.tex=%.aux) \
+ Vorbis_I_spec.4ct Vorbis_I_spec.4tc \
+ Vorbis_I_spec.dvi Vorbis_I_spec.idv \
+ Vorbis_I_spec.lg Vorbis_I_spec.log \
+ Vorbis_I_spec.out Vorbis_I_spec.tmp \
+ Vorbis_I_spec.toc Vorbis_I_spec.xref \
+ Vorbis_I_spec.out.ps \
+ zzVorbis_I_spec.ps
DISTCLEANFILES = $(built_docs)
-CLEANFILES = Vorbis_I_spec.fo spec.aux spec.log spec.out
-
-# rules for temporary build dir for spec
-BUILDDIR = build
-# how to copy images to build dir
-SPEC_PNG_BUILD = $(foreach file, $(SPEC_PNG), $(BUILDDIR)/$(file))
-SPEC_PDF_BUILD = $(foreach file, $(SPEC_PDF), $(BUILDDIR)/$(file))
-$(BUILDDIR)/%: $(srcdir)/%
- @echo "Copying $< to $@"
- @mkdir -p $(BUILDDIR)
- @cp $< $@
-
-# how to copy the xml to build dir; cheat by only targeting the main one
-$(BUILDDIR)/Vorbis_I_spec.xml: $(doc_sources)
- @mkdir -p $(BUILDDIR)
- @for file in $(doc_sources); do cp $(srcdir)/$$file $(BUILDDIR); done
-# translate the draft rtp.txt to .xml in the BUILDDIR
-$(BUILDDIR)/draft-rtp.xml: draft-kerr-avt-vorbis-rtp-03.txt
- cat $< | sed 's/\f//g' > $@
-# cat $< | sed 's/\f//g' | sed 's/</\</g' | sed 's/>/\>/g' > $@
+
# explicit rules for generating docs
if BUILD_DOCS
-Vorbis_I_spec.html: $(SPEC_PNG_BUILD) $(BUILDDIR)/Vorbis_I_spec.xml
- cd build; xsltproc --xinclude --output Vorbis_I_spec.html spec-html.xsl Vorbis_I_spec.xml && mv $@ ..
-
-Vorbis_I_spec.fo: $(BUILDDIR)/Vorbis_I_spec.xml
- cd build; xsltproc --xinclude --output $@ spec-fo.xsl Vorbis_I_spec.xml && mv $@ ..
-
-Vorbis_I_spec.pdf: Vorbis_I_spec.fo $(SPEC_PNG_BUILD) $(SPEC_PDF_BUILD)
- cp $< build/spec.fo # work around a passivetex bug
- cd build; pdfxmltex --interaction nonstopmode spec.fo
- cd build; pdfxmltex --interaction nonstopmode spec.fo
- rm build/spec.fo
- mv build/spec.pdf $@
+Vorbis_I_spec.html Vorbis_I_spec.css: $(SPEC_TEX) $(SPEC_PNG) fish_xiph_org.png
+ htlatex $<
+
+Vorbis_I_spec.pdf: $(SPEC_TEX) $(SPEC_PNG)
+ pdflatex $<
+ pdflatex $<
+ pdflatex $<
else
Vorbis_I_spec.html: NO_DOCS_ERROR
Vorbis_I_spec.pdf: NO_DOCS_ERROR
@echo
endif
-# clean up build dir
+if HAVE_DOXYGEN
+doxygen-build.stamp: Doxyfile $(top_srcdir)/include/vorbis/*.h
+ doxygen
+ touch doxygen-build.stamp
+else
+doxygen-build.stamp:
+ echo "*** Warning: Documentation build is disabled."
+ touch doxygen-build.stamp
+endif
+
+install-data-local: doxygen-build.stamp
+ $(mkinstalldirs) $(DESTDIR)$(docdir)
+ if test -d vorbis; then \
+ for dir in vorbis/*; do \
+ if test -d $$dir; then \
+ b=`basename $$dir`; \
+ $(mkinstalldirs) $(DESTDIR)$(docdir)/$$b; \
+ for f in $$dir/*; do \
+ $(INSTALL_DATA) $$f $(DESTDIR)$(docdir)/$$b; \
+ done \
+ fi \
+ done \
+ fi
+
+uninstall-local:
+ rm -rf $(DESTDIR)$(docdir)
+
clean-local:
- -$(RM) -r $(BUILDDIR)
+ if test -d vorbis; then rm -rf vorbis; fi
+ if test -f doxygen-build.stamp; then rm -f doxygen-build.stamp; fi
+
+
projects / platform / upstream / libvorbis.git / blobdiff