maintainer-scripts/update_web_docs

   1 #!/bin/sh -x
   2
   3 # Generate HTML documentation from GCC Texinfo docs.
   4 # This version is for GCC 3.1 and later versions.
   5
   6 # Run this from /tmp.
   7 CVSROOT=/cvs/gcc
   8 export CVSROOT
   9
  10 PATH=/usr/local/bin:$PATH
  11
  12 WWWBASE=/www/gcc/htdocs
  13 WWWBASE_PREFORMATTED=/www/gcc/htdocs-preformatted
  14 WWWPREPROCESS='/www/gcc/bin/preprocess -r'
  15
  16 # Process options -rrelease and -ddirectory
  17 RELEASE=""
  18 SUBDIR=""
  19
  20 while [ $# -gt 0 ]; do
  21   case $1 in
  22     -r*)
  23       if [ -n "$RELEASE" ]; then
  24         echo "Multiple releases specified" >&2
  25         exit 1
  26       fi
  27       RELEASE="${1#-r}"
  28       if [ -z "$RELEASE" ]; then
  29         shift
  30         RELEASE="$1"
  31         if [ -z "$RELEASE" ]; then
  32           echo "No release specified with -r" >&2
  33           exit 1
  34         fi
  35       fi
  36       ;;
  37     -d*)
  38       if [ -n "$SUBDIR" ]; then
  39         echo "Multiple subdirectories specified" >&2
  40         exit 1
  41       fi
  42       SUBDIR="${1#-d}"
  43       if [ -z "$SUBDIR" ]; then
  44         shift
  45         SUBDIR="$1"
  46         if [ -z "$SUBDIR" ]; then
  47           echo "No subdirectory specified with -d" >&2
  48           exit 1
  49         fi
  50       fi
  51       ;;
  52     *)
  53       echo "Unknown argument \"$1\"" >&2
  54       exit 1
  55       ;;
  56   esac
  57   shift
  58 done
  59
  60 if [ -n "$RELEASE" ] && [ -z "$SUBDIR" ]; then
  61   echo "Release specified without subdirectory" >&2
  62   exit 1
  63 fi
  64
  65 if [ -z "$SUBDIR" ]; then
  66   DOCSDIR=$WWWBASE/onlinedocs
  67 else
  68   DOCSDIR=$WWWBASE/onlinedocs/$SUBDIR
  69 fi
  70
  71 if [ ! -d $DOCSDIR ]; then
  72   mkdir $DOCSDIR
  73 fi
  74
  75 if [ -z "$RELEASE" ]; then
  76   RELEASE=HEAD
  77 fi
  78
  79 WORKDIR=/tmp/gcc-doc-update.$$
  80
  81 /bin/rm -rf $WORKDIR
  82 /bin/mkdir $WORKDIR
  83 cd $WORKDIR
  84
  85 # Find all the texi files in the repository, except those in directories
  86 # we do not care about (texinfo, etc).
  87 find $CVSROOT/gcc -name \*.texi,v -print | fgrep -v -f/home/gccadmin/scripts/doc_exclude | sed -e s#$CVSROOT/##g -e s#,v##g -e s#Attic/##g > FILES
  88
  89
  90 # Checkout all the texi files.
  91 cvs -Q export -r$RELEASE `cat FILES` gcc/gcc/doc/install.texi2html gcc/gcc/doc/include/texinfo.tex gcc/gcc/ada/xgnatugn.adb gcc/gcc/ada/ug_words gcc/gcc/BASE-VER gcc/gcc/DEV-PHASE
  92
  93 # Build a tarball of the sources.
  94 tar cf docs-sources.tar gcc
  95
  96 # The directory to pass to -I; this is the one with texinfo.tex
  97 # and fdl.texi.
  98 includedir=gcc/gcc/doc/include
  99
 100 MANUALS="cpp cppinternals fastjar gcc gccint gcj g77 gfortran gnat_ug_unx gnat_ug_vms gnat_ug_vxw gnat_ug_wnt gnat_ugn_unw gnat-style gnat_rm libiberty porting"
 101
 102 # Generate gnat_ugn_unw
 103
 104 if [ -f gcc/gcc/ada/xgnatugn.adb ]; then
 105    gnatmake -q gcc/gcc/ada/xgnatugn
 106    ./xgnatugn unw gcc/gcc/ada/gnat_ugn.texi \
 107      gcc/gcc/ada/ug_words gnat_ugn_unw.texi
 108 fi
 109
 110 # Generate gcc-vers.texi.
 111 (
 112    echo "@set version-GCC $(cat gcc/gcc/BASE-VER)"
 113    if "$(cat gcc/gcc/DEV-PHASE)" = "experimental"; then
 114       echo "@set DEVELOPMENT"
 115    else
 116       echo "@clear DEVELOPMENT"
 117    fi
 118 ) > $includedir/gcc-vers.texi
 119
 120 # Now convert the relevant files from texi to HTML and PostScript.
 121 for file in $MANUALS; do
 122   filename=`find . -name ${file}.texi`
 123   if [ "${filename}" ]; then
 124     makeinfo --html -I ${includedir} -I `dirname ${filename}` ${filename}
 125     tar cf ${file}-html.tar ${file}/*.html
 126     texi2dvi -I ${includedir} ${filename} </dev/null && dvips -o ${file}.ps ${file}.dvi
 127     mkdir -p $DOCSDIR/$file
 128   fi
 129 done
 130
 131 # Then build a gzipped copy of each of the resulting .html, .ps and .tar files
 132 for file in */*.html *.ps *.tar; do
 133   cat $file | gzip --best > $file.gz
 134 done
 135
 136 # On the 15th of the month, wipe all the old files from the
 137 # web server.
 138 today=`date +%d`
 139 if test $today = 15; then
 140   find $DOCSDIR -type f -maxdepth 1 -print | grep -v index.html | xargs rm
 141   for m in $MANUALS; do
 142     rm $DOCSDIR/$m/*.html $DOCSDIR/$m/*.html.gz
 143   done
 144 fi
 145
 146 # And copy the resulting files to the web server
 147 for file in */*.html *.ps *.tar; do
 148   cat $DOCSDIR/$file |
 149     sed -e '/^<meta name=generator/d' \
 150         -e '/^%DVIPSSource:/d' > file1
 151   cat $file |
 152     sed -e '/^<meta name=generator/d' \
 153         -e '/^%DVIPSSource:/d' > file2
 154   if cmp -s file1 file2; then
 155     :
 156   else
 157     cp $file $DOCSDIR/$file
 158     cp $file.gz $DOCSDIR/$file.gz
 159   fi
 160 done
 161
 162 cd $DOCSDIR
 163
 164 # Finally, generate the installation documentation (but only for CVS HEAD).
 165 if [ "$RELEASE" = "HEAD" ]; then
 166   SOURCEDIR=$WORKDIR/gcc/gcc/doc
 167   DESTDIR=$WWWBASE_PREFORMATTED/install
 168   export SOURCEDIR
 169   export DESTDIR
 170   $WORKDIR/gcc/gcc/doc/install.texi2html
 171
 172   # Preprocess the entire web site, not just the install docs!
 173   echo "Invoking $WWWPREPROCESS"
 174   $WWWPREPROCESS |grep -v '^  Warning: Keeping'
 175 fi
 176
 177 # Clean up behind us.
 178
 179 rm -rf $WORKDIR