3 # Generate HTML documentation from GCC Texinfo docs.
5 # If you want to run this on a machine different from gcc.gnu.org, you
6 # may need to adjust SVNROOT and WWWBASE below (or override them via the
12 SVNROOT
=${SVNROOT:-"file:///svn/gcc"}
15 PATH
=/usr
/local
/bin
:$PATH
37 WWWBASE
=${WWWBASE:-"/www/gcc/htdocs"}
38 WWWBASE_PREFORMATTED
=/www
/gcc
/htdocs-preformatted
39 WWWPREPROCESS
='/www/gcc/bin/preprocess -r'
41 # Process options -rrelease and -ddirectory
45 while [ $# -gt 0 ]; do
48 if [ -n "$RELEASE" ]; then
49 echo "Multiple releases specified" >&2
53 if [ -z "$RELEASE" ]; then
56 if [ -z "$RELEASE" ]; then
57 echo "No release specified with -r" >&2
63 if [ -n "$SUBDIR" ]; then
64 echo "Multiple subdirectories specified" >&2
68 if [ -z "$SUBDIR" ]; then
71 if [ -z "$SUBDIR" ]; then
72 echo "No subdirectory specified with -d" >&2
78 echo "Unknown argument \"$1\"" >&2
85 if [ -n "$RELEASE" ] && [ -z "$SUBDIR" ]; then
86 echo "Release specified without subdirectory" >&2
90 if [ -z "$SUBDIR" ]; then
91 DOCSDIR
=$WWWBASE/onlinedocs
93 DOCSDIR
=$WWWBASE/onlinedocs
/$SUBDIR
96 if [ ! -d $WWWBASE ]; then
97 echo "WWW base directory \"$WWWBASE\" does not exist." >&2
101 if [ ! -d $DOCSDIR ]; then
106 if [ -z "$RELEASE" ]; then
110 WORKDIR
=/tmp
/gcc-doc-update.$$
115 if [ "$RELEASE" = "trunk" ]; then
116 svn
-q export $SVNROOT/$RELEASE gcc
118 svn
-q export $SVNROOT/tags
/$RELEASE gcc
121 # Remove all unwanted files. This is needed to avoid packaging all the
122 # sources instead of only documentation sources.
123 # Note that we have to preserve gcc/jit/docs since the jit docs are
124 # not .texi files (Makefile, .rst and .png), and the jit docs use
125 # include directives to pull in content from jit/jit-common.h and
126 # jit/notes.txt, so we have to preserve those also.
127 find gcc
-type f \
( -name '*.texi' \
128 -o -path gcc
/gcc
/doc
/install.texi2html \
129 -o -path gcc
/gcc
/doc
/include
/texinfo.tex \
130 -o -path gcc
/gcc
/BASE-VER \
131 -o -path gcc
/gcc
/DEV-PHASE \
132 -o -path "gcc/gcc/ada/doc/gnat_ugn/*.png" \
133 -o -path "gcc/gcc/jit/docs/*" \
134 -o -path "gcc/gcc/jit/jit-common.h" \
135 -o -path "gcc/gcc/jit/notes.txt" \
136 -o -print0 \
) |
xargs -0 rm -f
138 # Build a tarball of the sources.
139 tar cf docs-sources.
tar gcc
141 # The directory to pass to -I; this is the one with texinfo.tex
143 includedir
=gcc
/gcc
/doc
/include
145 # Generate gcc-vers.texi.
147 echo "@set version-GCC $(cat gcc/gcc/BASE-VER)"
148 if [ "$(cat gcc/gcc/DEV-PHASE)" = "experimental" ]; then
149 echo "@set DEVELOPMENT"
151 echo "@clear DEVELOPMENT"
153 echo "@set srcdir $WORKDIR/gcc/gcc"
154 echo "@set VERSION_PACKAGE (GCC)"
155 echo "@set BUGURL @uref{http://gcc.gnu.org/bugs/}"
156 ) > $includedir/gcc-vers.texi
158 # Generate libquadmath-vers.texi.
159 echo "@set BUGURL @uref{http://gcc.gnu.org/bugs/}" \
160 > $includedir/libquadmath-vers.texi
162 # Now convert the relevant files from texi to HTML, PDF and PostScript.
163 for file in $MANUALS; do
164 filename
=`find . -name ${file}.texi`
165 if [ "${filename}" ]; then
166 includes
="-I ${includedir} -I `dirname ${filename}`"
167 if [ "$file" = "gnat_ugn" ]; then
168 includes
="$includes -I gcc/gcc/ada -I gcc/gcc/ada/doc/gnat_ugn"
170 makeinfo
--html --css-ref $CSS $includes -o ${file} ${filename}
171 tar cf
${file}-html.
tar ${file}/*.html
172 texi2dvi
$includes -o ${file}.dvi ${filename} </dev/null >/dev/null && dvips -o ${file}.ps ${file}.dvi
173 texi2pdf
$includes -o ${file}.pdf
${filename} </dev
/null
174 mkdir
-p $DOCSDIR/$file
178 # The jit is a special-case, using sphinx rather than texinfo.
179 # Specifically, the jit docs need sphinx 1.0 or later.
181 # The jit/docs Makefile uses the executable $(SPHINXBUILD),
182 # defaulting to "sphinx-build".
184 # sphinx is packaged in Fedora and EPEL 6 within "python-sphinx",
185 # and in openSUSE within "python-Sphinx".
187 # For EPEL6, python-sphinx is sphinx 0.6.6, which is missing various
188 # directives (e.g. ":c:macro:"), so we need the variant
189 # python-sphinx10 package. The latter installs its executable as
190 # /usr/bin/sphinx-1.0-build
191 # so we need to override SPHINXBUILD with this when invoking "make".
192 pushd gcc
/gcc
/jit
/docs
193 make SPHINXBUILD
=/usr
/bin
/sphinx-1.0
-build html || true
195 cp -a gcc
/gcc
/jit
/docs
/_build
/html jit
196 mkdir
-p $DOCSDIR/jit
198 # Work around makeinfo generated file names and references with
199 # "_002d" instead of "-".
200 find .
-name '*.html' |
while read f
; do
201 # Do this for the contents of each file.
202 sed -i -e 's/_002d/-/g' "$f"
203 # And rename files if necessary.
204 ff
=`echo $f | sed -e 's/_002d/-/g'`;
205 if [ "$f" != "$ff" ]; then
206 printf "Renaming %s to %s\n" "$f" "$ff"
211 # Then build a gzipped copy of each of the resulting .html, .ps and .tar files
212 for file in */*.html
*.ps
*.pdf
*.
tar; do
213 cat $file |
gzip --best > $file.gz
216 # On the 15th of the month, wipe all the old files from the
219 if test $today = 15; then
220 find $DOCSDIR -type f
-maxdepth 1 -print |
grep -v index.html |
xargs rm
221 for m
in $MANUALS; do
222 rm -f $DOCSDIR/$m/*.html
$DOCSDIR/$m/*.html.gz
226 # And copy the resulting files to the web server
227 for file in */*.html
*.ps
*.pdf
*.
tar; do
228 if [ -f $DOCSDIR/$file ]; then
230 sed -e '/^<meta name=generator/d' \
231 -e '/^%DVIPSSource:/d' > file1
234 sed -e '/^<meta name=generator/d' \
235 -e '/^%DVIPSSource:/d' > file2
236 if cmp -s file1 file2
; then
239 cp $file $DOCSDIR/$file
240 cp $file.gz
$DOCSDIR/$file.gz
244 # Again, the jit is a special case, with nested subdirectories
245 # below "jit", and with some non-HTML files (.png images from us,
246 # plus .css and .js supplied by sphinx, and source files, renamed
247 # from .rst to .txt).
249 -name "*.html" -o -name "*.png" \
250 -o -name "*.css" -o -name "*.js" \
253 # Note that $file here will contain path fragments beginning
254 # with "jit/", e.g. "jit/cp/topics/functions.html"
255 mkdir
-p $
(dirname $DOCSDIR/$file)
256 cp $file $DOCSDIR/$file
261 # Finally, generate the installation documentation
262 if [ "$RELEASE" = "trunk" ]; then
263 SOURCEDIR
=$WORKDIR/gcc
/gcc
/doc
264 DESTDIR
=$WWWBASE_PREFORMATTED/install
267 $WORKDIR/gcc
/gcc
/doc
/install.texi2html
269 # Preprocess the entire web site, not just the install docs!
270 echo "Invoking $WWWPREPROCESS"
271 $WWWPREPROCESS |
grep -v '^ Warning: Keeping'
274 # Clean up behind us.