Skip to content

Commit 96f750a

Browse files
committed
Fix dependency loop in the specification.
Building the html version of the Vorbis format specification creates a series of image files containing figures and rendered equations. Previously we were treating these as part of the static documentation, since we keep a copy of the spec in the repository. Hopever, since the static images were listed as dependencies of the specification document (as the not-generated ones are) rebuilding the spec necessarily rebuilt them as well, which meant the spec would always be considered out of date and rebuilt needlessly. Instead, split the static image files from the set which are generated as part of the specification build process, and only mark dependence on the former. This allows us to drop the inconsistent DISTCLEAN line which was working around the problem of always needing to rebuild the spec, even when it was included in the distribution. Signed-off-by: Mark Harris <[email protected]>
1 parent 6b30b1f commit 96f750a

File tree

1 file changed

+22
-19
lines changed

1 file changed

+22
-19
lines changed

doc/Makefile.am

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,22 @@ static_docs = \
2727
vorbis-fidelity.html
2828

2929
# bits needed by the spec
30+
SPEC_TEX = \
31+
Vorbis_I_spec.tex \
32+
01-introduction.tex \
33+
02-bitpacking.tex \
34+
03-codebook.tex \
35+
04-codec.tex \
36+
05-comment.tex \
37+
06-floor0.tex \
38+
07-floor1.tex \
39+
08-residue.tex \
40+
09-helper.tex \
41+
10-tables.tex \
42+
a1-encapsulation-ogg.tex \
43+
a2-encapsulation-rtp.tex \
44+
footer.tex
45+
3046
SPEC_PNG = \
3147
components.png \
3248
floor1-1.png \
@@ -38,7 +54,10 @@ SPEC_PNG = \
3854
residue-pack.png \
3955
residue2.png \
4056
window1.png \
41-
window2.png \
57+
window2.png
58+
59+
# Figure images generated by htlatex
60+
built_SPEC_PNG = \
4261
Vorbis_I_spec0x.png \
4362
Vorbis_I_spec1x.png \
4463
Vorbis_I_spec2x.png \
@@ -55,23 +74,9 @@ SPEC_PNG = \
5574
Vorbis_I_spec13x.png \
5675
Vorbis_I_spec14x.png
5776

58-
SPEC_TEX = \
59-
Vorbis_I_spec.tex \
60-
01-introduction.tex \
61-
02-bitpacking.tex \
62-
03-codebook.tex \
63-
04-codec.tex \
64-
05-comment.tex \
65-
06-floor0.tex \
66-
07-floor1.tex \
67-
08-residue.tex \
68-
09-helper.tex \
69-
10-tables.tex \
70-
a1-encapsulation-ogg.tex \
71-
a2-encapsulation-rtp.tex \
72-
footer.tex
7377

74-
built_docs = Vorbis_I_spec.pdf Vorbis_I_spec.html Vorbis_I_spec.css
78+
built_docs = Vorbis_I_spec.pdf \
79+
Vorbis_I_spec.html Vorbis_I_spec.css $(built_SPEC_PNG)
7580

7681
# conditionally make the generated documentation
7782
if BUILD_DOCS
@@ -93,8 +98,6 @@ CLEANFILES = $(SPEC_TEX:%.tex=%.aux) \
9398
Vorbis_I_spec.toc Vorbis_I_spec.xref \
9499
Vorbis_I_spec.out.ps \
95100
zzVorbis_I_spec.ps
96-
DISTCLEANFILES = $(built_docs)
97-
98101

99102
# explicit rules for generating docs
100103
if BUILD_DOCS

0 commit comments

Comments
 (0)