|
145
|
1 #!/bin/sh
|
|
|
2
|
|
|
3 # Generate HTML documentation from GCC Texinfo docs.
|
|
|
4 #
|
|
|
5 # If you want to run this on a machine different from gcc.gnu.org, you
|
|
|
6 # may need to adjust GITROOT and WWWBASE below (or override them via the
|
|
|
7 # environment).
|
|
|
8
|
|
|
9 set -e
|
|
|
10
|
|
|
11 # Run this from /tmp.
|
|
|
12 GITROOT=${GITROOT:-"/git/gcc.git"}
|
|
|
13 export GITROOT
|
|
|
14
|
|
|
15 PATH=/usr/local/bin:$PATH
|
|
|
16
|
|
|
17 MANUALS="cpp
|
|
|
18 cppinternals
|
|
|
19 fastjar
|
|
|
20 gcc
|
|
|
21 gccgo
|
|
|
22 gccint
|
|
|
23 gcj
|
|
|
24 gfortran
|
|
|
25 gfc-internals
|
|
|
26 gnat_ugn
|
|
|
27 gnat-style
|
|
|
28 gnat_rm
|
|
|
29 libgomp
|
|
|
30 libitm
|
|
|
31 libquadmath
|
|
|
32 libiberty
|
|
|
33 porting"
|
|
|
34
|
|
|
35 CSS=/gcc.css
|
|
|
36
|
|
|
37 WWWBASE=${WWWBASE:-"/www/gcc/htdocs"}
|
|
|
38 WWWBASE_PREFORMATTED=/www/gcc/htdocs-preformatted
|
|
|
39 WWWPREPROCESS='/www/gcc/bin/preprocess -r'
|
|
|
40
|
|
|
41 # Process options -rrelease and -ddirectory
|
|
|
42 RELEASE=""
|
|
|
43 SUBDIR=""
|
|
|
44
|
|
|
45 while [ $# -gt 0 ]; do
|
|
|
46 case $1 in
|
|
|
47 -r*)
|
|
|
48 if [ -n "$RELEASE" ]; then
|
|
|
49 echo "Multiple releases specified" >&2
|
|
|
50 exit 1
|
|
|
51 fi
|
|
|
52 RELEASE="${1#-r}"
|
|
|
53 if [ -z "$RELEASE" ]; then
|
|
|
54 shift
|
|
|
55 RELEASE="$1"
|
|
|
56 if [ -z "$RELEASE" ]; then
|
|
|
57 echo "No release specified with -r" >&2
|
|
|
58 exit 1
|
|
|
59 fi
|
|
|
60 fi
|
|
|
61 ;;
|
|
|
62 -d*)
|
|
|
63 if [ -n "$SUBDIR" ]; then
|
|
|
64 echo "Multiple subdirectories specified" >&2
|
|
|
65 exit 1
|
|
|
66 fi
|
|
|
67 SUBDIR="${1#-d}"
|
|
|
68 if [ -z "$SUBDIR" ]; then
|
|
|
69 shift
|
|
|
70 SUBDIR="$1"
|
|
|
71 if [ -z "$SUBDIR" ]; then
|
|
|
72 echo "No subdirectory specified with -d" >&2
|
|
|
73 exit 1
|
|
|
74 fi
|
|
|
75 fi
|
|
|
76 ;;
|
|
|
77 *)
|
|
|
78 echo "Unknown argument \"$1\"" >&2
|
|
|
79 exit 1
|
|
|
80 ;;
|
|
|
81 esac
|
|
|
82 shift
|
|
|
83 done
|
|
|
84
|
|
|
85 if [ -n "$RELEASE" ] && [ -z "$SUBDIR" ]; then
|
|
|
86 echo "Release specified without subdirectory" >&2
|
|
|
87 exit 1
|
|
|
88 fi
|
|
|
89
|
|
|
90 if [ -z "$SUBDIR" ]; then
|
|
|
91 DOCSDIR=$WWWBASE/onlinedocs
|
|
|
92 else
|
|
|
93 DOCSDIR=$WWWBASE/onlinedocs/$SUBDIR
|
|
|
94 fi
|
|
|
95
|
|
|
96 if [ ! -d $WWWBASE ]; then
|
|
|
97 echo "WWW base directory \"$WWWBASE\" does not exist." >&2
|
|
|
98 exit 1
|
|
|
99 fi
|
|
|
100
|
|
|
101 if [ ! -d $DOCSDIR ]; then
|
|
|
102 mkdir $DOCSDIR
|
|
|
103 chmod g+w $DOCSDIR
|
|
|
104 fi
|
|
|
105
|
|
|
106 if [ -z "$RELEASE" ]; then
|
|
|
107 RELEASE=master
|
|
|
108 fi
|
|
|
109
|
|
|
110 WORKDIR=/tmp/gcc-doc-update.$$
|
|
|
111
|
|
|
112 rm -rf $WORKDIR
|
|
|
113 mkdir $WORKDIR
|
|
|
114 cd $WORKDIR
|
|
|
115 if [ "$RELEASE" = "master" ]; then
|
|
|
116 git clone -q $GITROOT gcc
|
|
|
117 else
|
|
|
118 git clone -q -b releases/gcc-$RELEASE $GITROOT gcc
|
|
|
119 fi
|
|
|
120 rm -rf gcc/.git
|
|
|
121
|
|
|
122 # Remove all unwanted files. This is needed to avoid packaging all the
|
|
|
123 # sources instead of only documentation sources.
|
|
|
124 # Note that we have to preserve gcc/jit/docs since the jit docs are
|
|
|
125 # not .texi files (Makefile, .rst and .png), and the jit docs use
|
|
|
126 # include directives to pull in content from jit/jit-common.h and
|
|
|
127 # jit/notes.txt, so we have to preserve those also.
|
|
|
128 find gcc -type f \( -name '*.texi' \
|
|
|
129 -o -path gcc/gcc/doc/install.texi2html \
|
|
|
130 -o -path gcc/gcc/doc/include/texinfo.tex \
|
|
|
131 -o -path gcc/gcc/BASE-VER \
|
|
|
132 -o -path gcc/gcc/DEV-PHASE \
|
|
|
133 -o -path "gcc/gcc/ada/doc/gnat_ugn/*.png" \
|
|
|
134 -o -path "gcc/gcc/jit/docs/*" \
|
|
|
135 -o -path "gcc/gcc/jit/jit-common.h" \
|
|
|
136 -o -path "gcc/gcc/jit/notes.txt" \
|
|
|
137 -o -print0 \) | xargs -0 rm -f
|
|
|
138
|
|
|
139 # Build a tarball of the sources.
|
|
|
140 tar cf docs-sources.tar gcc
|
|
|
141
|
|
|
142 # The directory to pass to -I; this is the one with texinfo.tex
|
|
|
143 # and fdl.texi.
|
|
|
144 includedir=gcc/gcc/doc/include
|
|
|
145
|
|
|
146 # Generate gcc-vers.texi.
|
|
|
147 (
|
|
|
148 echo "@set version-GCC $(cat gcc/gcc/BASE-VER)"
|
|
|
149 if [ "$(cat gcc/gcc/DEV-PHASE)" = "experimental" ]; then
|
|
|
150 echo "@set DEVELOPMENT"
|
|
|
151 else
|
|
|
152 echo "@clear DEVELOPMENT"
|
|
|
153 fi
|
|
|
154 echo "@set srcdir $WORKDIR/gcc/gcc"
|
|
|
155 echo "@set VERSION_PACKAGE (GCC)"
|
|
|
156 echo "@set BUGURL @uref{http://gcc.gnu.org/bugs/}"
|
|
|
157 ) > $includedir/gcc-vers.texi
|
|
|
158
|
|
|
159 # Generate libquadmath-vers.texi.
|
|
|
160 echo "@set BUGURL @uref{http://gcc.gnu.org/bugs/}" \
|
|
|
161 > $includedir/libquadmath-vers.texi
|
|
|
162
|
|
|
163 # Now convert the relevant files from texi to HTML, PDF and PostScript.
|
|
|
164 for file in $MANUALS; do
|
|
|
165 filename=`find . -name ${file}.texi`
|
|
|
166 if [ "${filename}" ]; then
|
|
|
167 includes="-I ${includedir} -I `dirname ${filename}`"
|
|
|
168 if [ "$file" = "gnat_ugn" ]; then
|
|
|
169 includes="$includes -I gcc/gcc/ada -I gcc/gcc/ada/doc/gnat_ugn"
|
|
|
170 fi
|
|
|
171 makeinfo --html --css-ref $CSS $includes -o ${file} ${filename}
|
|
|
172 tar cf ${file}-html.tar ${file}/*.html
|
|
|
173 texi2dvi $includes -o ${file}.dvi ${filename} </dev/null >/dev/null && dvips -o ${file}.ps ${file}.dvi
|
|
|
174 texi2pdf $includes -o ${file}.pdf ${filename} </dev/null
|
|
|
175 mkdir -p $DOCSDIR/$file
|
|
|
176 fi
|
|
|
177 done
|
|
|
178
|
|
|
179 # The jit is a special-case, using sphinx rather than texinfo.
|
|
|
180 # Specifically, the jit docs need sphinx 1.0 or later.
|
|
|
181 #
|
|
|
182 # The jit/docs Makefile uses the executable $(SPHINXBUILD),
|
|
|
183 # defaulting to "sphinx-build".
|
|
|
184 #
|
|
|
185 # sphinx is packaged in Fedora and EPEL 6 within "python-sphinx",
|
|
|
186 # and in openSUSE within "python-Sphinx".
|
|
|
187 #
|
|
|
188 # For EPEL6, python-sphinx is sphinx 0.6.6, which is missing various
|
|
|
189 # directives (e.g. ":c:macro:"), so we need the variant
|
|
|
190 # python-sphinx10 package. The latter installs its executable as
|
|
|
191 # /usr/bin/sphinx-1.0-build
|
|
|
192 # so we need to override SPHINXBUILD with this when invoking "make".
|
|
|
193 pushd gcc/gcc/jit/docs
|
|
|
194 make SPHINXBUILD=/usr/bin/sphinx-1.0-build html || true
|
|
|
195 popd
|
|
|
196 cp -a gcc/gcc/jit/docs/_build/html jit
|
|
|
197 mkdir -p $DOCSDIR/jit
|
|
|
198
|
|
|
199 # Work around makeinfo generated file names and references with
|
|
|
200 # "_002d" instead of "-".
|
|
|
201 find . -name '*.html' | while read f; do
|
|
|
202 # Do this for the contents of each file.
|
|
|
203 sed -i -e 's/_002d/-/g' "$f"
|
|
|
204 # And rename files if necessary.
|
|
|
205 ff=`echo $f | sed -e 's/_002d/-/g'`;
|
|
|
206 if [ "$f" != "$ff" ]; then
|
|
|
207 printf "Renaming %s to %s\n" "$f" "$ff"
|
|
|
208 mv "$f" "$ff"
|
|
|
209 fi
|
|
|
210 done
|
|
|
211
|
|
|
212 # Then build a gzipped copy of each of the resulting .html, .ps and .tar files
|
|
|
213 for file in */*.html *.ps *.pdf *.tar; do
|
|
|
214 cat $file | gzip --best > $file.gz
|
|
|
215 done
|
|
|
216
|
|
|
217 # On the 15th of the month, wipe all the old files from the
|
|
|
218 # web server.
|
|
|
219 today=`date +%d`
|
|
|
220 if test $today = 15; then
|
|
|
221 find $DOCSDIR -type f -maxdepth 1 -print | grep -v index.html | xargs rm
|
|
|
222 for m in $MANUALS; do
|
|
|
223 rm -f $DOCSDIR/$m/*.html $DOCSDIR/$m/*.html.gz
|
|
|
224 done
|
|
|
225 fi
|
|
|
226
|
|
|
227 # And copy the resulting files to the web server
|
|
|
228 for file in */*.html *.ps *.pdf *.tar; do
|
|
|
229 if [ -f $DOCSDIR/$file ]; then
|
|
|
230 cat $DOCSDIR/$file |
|
|
|
231 sed -e '/^<meta name=generator/d' \
|
|
|
232 -e '/^%DVIPSSource:/d' > file1
|
|
|
233 fi
|
|
|
234 cat $file |
|
|
|
235 sed -e '/^<meta name=generator/d' \
|
|
|
236 -e '/^%DVIPSSource:/d' > file2
|
|
|
237 if cmp -s file1 file2; then
|
|
|
238 :
|
|
|
239 else
|
|
|
240 cp $file $DOCSDIR/$file
|
|
|
241 cp $file.gz $DOCSDIR/$file.gz
|
|
|
242 fi
|
|
|
243 done
|
|
|
244
|
|
|
245 # Again, the jit is a special case, with nested subdirectories
|
|
|
246 # below "jit", and with some non-HTML files (.png images from us,
|
|
|
247 # plus .css and .js supplied by sphinx, and source files, renamed
|
|
|
248 # from .rst to .txt).
|
|
|
249 find jit \
|
|
|
250 -name "*.html" -o -name "*.png" \
|
|
|
251 -o -name "*.css" -o -name "*.js" \
|
|
|
252 -o -name "*.txt" |
|
|
|
253 while read file ; do
|
|
|
254 # Note that $file here will contain path fragments beginning
|
|
|
255 # with "jit/", e.g. "jit/cp/topics/functions.html"
|
|
|
256 mkdir -p $(dirname $DOCSDIR/$file)
|
|
|
257 cp $file $DOCSDIR/$file
|
|
|
258 done
|
|
|
259
|
|
|
260 cd $DOCSDIR
|
|
|
261
|
|
|
262 # Finally, generate the installation documentation
|
|
|
263 if [ "$RELEASE" = "master" ]; then
|
|
|
264 SOURCEDIR=$WORKDIR/gcc/gcc/doc
|
|
|
265 DESTDIR=$WWWBASE_PREFORMATTED/install
|
|
|
266 export SOURCEDIR
|
|
|
267 export DESTDIR
|
|
|
268 $WORKDIR/gcc/gcc/doc/install.texi2html
|
|
|
269
|
|
|
270 # Preprocess the entire web site, not just the install docs!
|
|
|
271 echo "Invoking $WWWPREPROCESS"
|
|
|
272 $WWWPREPROCESS |grep -v '^ Warning: Keeping'
|
|
|
273 fi
|
|
|
274
|
|
|
275 # Clean up behind us.
|
|
|
276
|
|
|
277 rm -rf $WORKDIR
|
