1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
#
# Conscript file for building SCons documentation.
#
#
# Copyright (c) 2001 Steven Knight
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
#
Import qw( env );
#
#
#
$doc_tar_gz = "#build/dist/scons-doc-${\$env->{VERSION}}.tar.gz";
#
# We'll only try to build text files (for some documents)
# if lynx is available to do the dump.
#
$lynx = cons::whereis('lynx');
#
# Always create a version.sgml file containing the version information
# for this run. Ignore it for dependency purposes so we don't
# rebuild all the docs every time just because the date changes.
#
$verfile = SourcePath("version.sgml");
unlink($verfile);
chmod(0664, $verfile);
open(FILE, ">$verfile") || die "Cannot open '$verfile': $!";
print FILE <<_EOF_;
<!--
THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT.
-->
<!ENTITY builddate "${\$env->{DATE}}">
<!ENTITY buildversion "${\$env->{VERSION}}">
<!ENTITY buildrevision "${\$env->{REVISION}}">
_EOF_
close(FILE);
Ignore("version.sgml");
#
# Each document will live in its own subdirectory. List them here
# as hash keys, with a hash of the info to control its build.
#
%doc_dirs = (
'design' => {
'html' => 'book1.html',
},
'man' => {
'html' => 'scons.html',
'text' => 1,
},
'user' => {
'html' => 'book1.html',
},
);
# Find internal dependencies in .sgml files:
#
# <!entity bground SYSTEM "bground.sgml">
# <graphic fileref="file.jpg">
#
# This only finds one per line, and assumes that anything
# defined as a SYSTEM entity is, in fact, a file included
# somewhere in the document.
sub scansgml {
my @includes = ();
do {
if (/<!entity\s+(?:%\s+)?(?:\S+)\s+SYSTEM\s+"([^"]*)">/i) {
push(@includes, $1);
} elsif (/<graphic[^>]*\sfileref="([^"]*)"/) {
push(@includes, "design/$1");
}
} while (<scan::quickscan::SCAN>);
@includes;
}
#
# We have to tell Cons to QuickScan the top-level SGML files which
# get included by the document SGML files in the subdirectories.
#
@included_sgml = qw(
scons.mod
copyright.sgml
);
foreach $sgml (@included_sgml) {
$env->QuickScan(\&scansgml, $sgml);
}
#
# For each document, build the document itself in HTML, Postscript,
# and PDF formats.
#
foreach $doc (keys %doc_dirs) {
my $main = "$doc/main.sgml";
my $out = "main.out";
my $htmldir = "HTML/scons-$doc";
my $html = "$htmldir/" . $doc_dirs{$doc}->{'html'};
my $ps = "PS/scons-$doc.ps";
my $pdf = "PDF/scons-$doc.pdf";
my $text = "TEXT/scons-$doc.txt";
$env->QuickScan(\&scansgml, $main);
$env->Command($html, $main,
qq(rm -f %>:d/*.html
jw -b html -o %>:d %<
mv -v %>:d/index.html %> || true
));
$env->Command($ps, $main,
qq(rm -f %>:d/$out
jw -b ps -o %>:d %<
mv %>:d/main.ps %>
rm -f %>:d/$out
));
$env->Command($pdf, $main,
qq(rm -f %>:d/$out
jw -b pdf -o %>:d %<
mv %>:d/main.pdf %>
rm -f %>:d/$out
));
if ($doc_dirs{$doc}->{'text'} && $lynx) {
$env->Command($text, $html, qq(lynx -dump %<:a > %>));
}
push(@tar_deps, $html, $ps, $pdf);
push(@tar_list, $htmldir, $ps, $pdf);
}
#
# Now actually create the tar file of the documentation,
# for easy distribution to the web site.
#
$env->Command($doc_tar_gz,
@tar_deps,
qq(tar zchv -f %> -C build/doc @tar_list));
|
