X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;ds=sidebyside;f=doc%2FMakefile.am;h=a98c4d83f2662afb2e99768610a3597853037539;hb=6b30b1f651e93488dd8f56962f509687d4c150d1;hp=e7268688bd36ef806c3737a11d168d2b3997cf83;hpb=ce13174d4aa17a060b9458a0cabb636a2dca5323;p=platform%2Fupstream%2Flibvorbis.git diff --git a/doc/Makefile.am b/doc/Makefile.am index e726868..a98c4d8 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,92 +1,149 @@ ## Process this with automake to create Makefile.in -SUBDIRS = vorbisfile vorbisenc +SUBDIRS = libvorbis vorbisfile vorbisenc docdir = $(datadir)/doc/$(PACKAGE)-$(VERSION) -static_docs = components.png \ - draft-kerr-avt-vorbis-rtp-03.txt \ +### all of the static docs, commited to SVN and included as is +static_docs = \ + rfc5215.xml \ + rfc5215.txt \ eightphase.png \ - evenlsp.png \ - floor1-1.png \ - floor1-2.png \ - floor1-3.png \ - floor1-4.png \ + fish_xiph_org.png \ floor1_inverse_dB_table.html \ floorval.png \ fourphase.png \ framing.html \ helper.html \ - hufftree-under.png \ - hufftree.png \ index.html \ - lspmap.png \ - oddlsp.png \ oggstream.html \ programming.html \ - residue-pack.png \ - residue2.png \ squarepolar.png \ stereo.html \ stream.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 \ + vorbis-fidelity.html + +# bits needed by the spec +SPEC_PNG = \ + components.png \ + floor1-1.png \ + floor1-2.png \ + floor1-3.png \ + floor1-4.png \ + hufftree.png \ + hufftree-under.png \ + residue-pack.png \ + residue2.png \ window1.png \ - window2.png + 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 -built_docs = Vorbis_I_spec.html Vorbis_I_spec.pdf +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) $(built_docs) +doc_DATA = $(static_docs) $(SPEC_PNG) $(built_docs) doxygen-build.stamp else -doc_DATA = $(static_docs) +doc_DATA = $(static_docs) doxygen-build.stamp endif -EXTRA_DIST = $(static_docs) $(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 - -nobase_EXTRA_DIST = $(doc_sources) +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 = Vorbis_I_spec.fo spec.aux spec.log spec.out +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) + # explicit rules for generating docs -Vorbis_I_spec.html: - xsltproc --xinclude --output $@ $(srcdir)/xml/spec-html.xsl $(srcdir)/xml/Vorbis_I_spec.xml - -Vorbis_I_spec.fo: - xsltproc --xinclude --output $@ $(srcdir)/xml/spec-fo.xsl $(srcdir)/xml/Vorbis_I_spec.xml - -Vorbis_I_spec.pdf: Vorbis_I_spec.fo - cp $< spec.fo # work around a passivetex bug - pdfxmltex --interaction nonstopmode spec.fo - pdfxmltex --interaction nonstopmode spec.fo - rm spec.fo - mv spec.pdf $@ +if BUILD_DOCS +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 +NO_DOCS_ERROR: + @echo + @echo "*** Documentation has not been built! ***" + @echo "Try re-running after passing --enable-docs to configure." + @echo +endif + +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: + if test -d vorbis; then rm -rf vorbis; fi + if test -f doxygen-build.stamp; then rm -f doxygen-build.stamp; fi +