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_ug_unx
  24   gnat_ug_vms
  25   gnat_ug_vxw
  26   gnat_ug_wnt
  27   gnat_ugn_unw
  28   gnat-style
  29   gnat_rm
  30   libgomp
  31   libquadmath
  32   libiberty
  33   porting"
  34
  35 WWWBASE=/www/gcc/htdocs
  36 WWWBASE_PREFORMATTED=/www/gcc/htdocs-preformatted
  37 WWWPREPROCESS='/www/gcc/bin/preprocess -r'
  38
  39 # Process options -rrelease and -ddirectory
  40 RELEASE=""
  41 SUBDIR=""
  42
  43 while [ $# -gt 0 ]; do
  44   case $1 in
  45     -r*)
  46       if [ -n "$RELEASE" ]; then
  47         echo "Multiple releases specified" >&2
  48         exit 1
  49       fi
  50       RELEASE="${1#-r}"
  51       if [ -z "$RELEASE" ]; then
  52         shift
  53         RELEASE="$1"
  54         if [ -z "$RELEASE" ]; then
  55           echo "No release specified with -r" >&2
  56           exit 1
  57         fi
  58       fi
  59       ;;
  60     -d*)
  61       if [ -n "$SUBDIR" ]; then
  62         echo "Multiple subdirectories specified" >&2
  63         exit 1
  64       fi
  65       SUBDIR="${1#-d}"
  66       if [ -z "$SUBDIR" ]; then
  67         shift
  68         SUBDIR="$1"
  69         if [ -z "$SUBDIR" ]; then
  70           echo "No subdirectory specified with -d" >&2
  71           exit 1
  72         fi
  73       fi
  74       ;;
  75     *)
  76       echo "Unknown argument \"$1\"" >&2
  77       exit 1
  78       ;;
  79   esac
  80   shift
  81 done
  82
  83 if [ -n "$RELEASE" ] && [ -z "$SUBDIR" ]; then
  84   echo "Release specified without subdirectory" >&2
  85   exit 1
  86 fi
  87
  88 if [ -z "$SUBDIR" ]; then
  89   DOCSDIR=$WWWBASE/onlinedocs
  90 else
  91   DOCSDIR=$WWWBASE/onlinedocs/$SUBDIR
  92 fi
  93
  94 if [ ! -d $DOCSDIR ]; then
  95   mkdir $DOCSDIR
  96   chmod g+w $DOCSDIR
  97 fi
  98
  99 if [ -z "$RELEASE" ]; then
 100   RELEASE=trunk
 101 fi
 102
 103 WORKDIR=/tmp/gcc-doc-update.$$
 104
 105 rm -rf $WORKDIR
 106 mkdir $WORKDIR
 107 cd $WORKDIR
 108 if [ "$RELEASE" = "trunk" ]; then
 109   svn -q export $SVNROOT/$RELEASE gcc
 110 else
 111   svn -q export $SVNROOT/tags/$RELEASE gcc
 112 fi
 113
 114 # Remove all unwanted files.  This is needed (a) to build the Ada
 115 # generator programs with the installed library, not the new one and
 116 # (b) to avoid packaging all the sources instead of only documentation
 117 # sources.
 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/ada/xgnatugn.adb \
 122   -o -path gcc/gcc/ada/ug_words \
 123   -o -path gcc/gcc/BASE-VER \
 124   -o -path gcc/gcc/DEV-PHASE \
 125   -o -print0 \) | xargs -0 rm -f
 126
 127 # Build a tarball of the sources.
 128 tar cf docs-sources.tar gcc
 129
 130 # The directory to pass to -I; this is the one with texinfo.tex
 131 # and fdl.texi.
 132 includedir=gcc/gcc/doc/include
 133
 134 # Generate gnat_ugn_unw
 135
 136 if [ -f gcc/gcc/ada/xgnatugn.adb ]; then
 137    gnatmake -q gcc/gcc/ada/xgnatugn
 138    ./xgnatugn unw gcc/gcc/ada/gnat_ugn.texi \
 139      gcc/gcc/ada/ug_words gnat_ugn_unw.texi
 140 fi
 141
 142 # Generate gcc-vers.texi.
 143 (
 144    echo "@set version-GCC $(cat gcc/gcc/BASE-VER)"
 145    if [ "$(cat gcc/gcc/DEV-PHASE)" = "experimental" ]; then
 146       echo "@set DEVELOPMENT"
 147    else
 148       echo "@clear DEVELOPMENT"
 149    fi
 150    echo "@set srcdir $WORKDIR/gcc/gcc"
 151    echo "@set VERSION_PACKAGE (GCC)"
 152    echo "@set BUGURL @uref{http://gcc.gnu.org/bugs/}"
 153 ) > $includedir/gcc-vers.texi
 154
 155 # Generate libquadmath-vers.texi.
 156 echo "@set BUGURL @uref{http://gcc.gnu.org/bugs/}" \
 157   > $includedir/libquadmath-vers.texi
 158
 159 # Now convert the relevant files from texi to HTML, PDF and PostScript.
 160 for file in $MANUALS; do
 161   filename=`find . -name ${file}.texi`
 162   if [ "${filename}" ]; then
 163     includes="-I ${includedir} -I `dirname ${filename}`"
 164     if [ "$file" = "gnat_ugn_unw" ]; then
 165       includes="$includes -I gcc/gcc/ada"
 166     fi
 167     makeinfo --html $includes -o ${file} ${filename}
 168     tar cf ${file}-html.tar ${file}/*.html
 169     texi2dvi $includes -o ${file}.dvi ${filename} </dev/null >/dev/null && dvips -o ${file}.ps ${file}.dvi
 170     texi2pdf $includes -o ${file}.pdf ${filename} </dev/null
 171     mkdir -p $DOCSDIR/$file
 172   fi
 173 done
 174
 175 # Work around makeinfo generated file names and references with
 176 # "_002d" instead of "-".
 177 find . -name '*.html' | while read f; do
 178   # Do this for the contents of each file.
 179   sed -i -e 's/_002d/-/g' "$f"
 180   # And rename files if necessary.
 181   ff=`echo $f | sed -e 's/_002d/-/g'`;
 182   if [ "$f" != "$ff" ]; then
 183     printf "Renaming %s to %s\n" "$f" "$ff"
 184     mv "$f" "$ff"
 185   fi
 186 done
 187
 188 # Then build a gzipped copy of each of the resulting .html, .ps and .tar files
 189 for file in */*.html *.ps *.pdf *.tar; do
 190   cat $file | gzip --best > $file.gz
 191 done
 192
 193 # On the 15th of the month, wipe all the old files from the
 194 # web server.
 195 today=`date +%d`
 196 if test $today = 15; then
 197   find $DOCSDIR -type f -maxdepth 1 -print | grep -v index.html | xargs rm
 198   for m in $MANUALS; do
 199     rm -f $DOCSDIR/$m/*.html $DOCSDIR/$m/*.html.gz
 200   done
 201 fi
 202
 203 # And copy the resulting files to the web server
 204 for file in */*.html *.ps *.pdf *.tar; do
 205   if [ -f $DOCSDIR/$file ]; then
 206     cat $DOCSDIR/$file |
 207       sed -e '/^<meta name=generator/d' \
 208           -e '/^%DVIPSSource:/d' > file1
 209   fi
 210   cat $file |
 211     sed -e '/^<meta name=generator/d' \
 212         -e '/^%DVIPSSource:/d' > file2
 213   if cmp -s file1 file2; then
 214     :
 215   else
 216     cp $file $DOCSDIR/$file
 217     cp $file.gz $DOCSDIR/$file.gz
 218   fi
 219 done
 220
 221 cd $DOCSDIR
 222
 223 # Finally, generate the installation documentation
 224 if [ "$RELEASE" = "trunk" ]; then
 225   SOURCEDIR=$WORKDIR/gcc/gcc/doc
 226   DESTDIR=$WWWBASE_PREFORMATTED/install
 227   export SOURCEDIR
 228   export DESTDIR
 229   $WORKDIR/gcc/gcc/doc/install.texi2html
 230
 231   # Preprocess the entire web site, not just the install docs!
 232   echo "Invoking $WWWPREPROCESS"
 233   $WWWPREPROCESS |grep -v '^  Warning: Keeping'
 234 fi
 235
 236 # Clean up behind us.
 237
 238 rm -rf $WORKDIR