maintainer-scripts/update_web_docs_svn

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