doc/README

   1 Misc notes
   2 ----------
   3
   4 regexprops-generic.texi is generated via a utility in findutils.
   5
   6 How to update gnulib manual on www.gnu.org
   7 ------------------------------------------
   8
   9 1) You need a non-anonymous checkout of the web pages directory.
  10
  11    $ cvs -d :ext:jas@cvs.savannah.gnu.org:/web/gnulib \
  12          checkout gnulib
  13
  14 2) Get familiar with the instructions for web page maintainers.
  15    http://www.gnu.org/server/standards/readme_index.html
  16    http://www.gnu.org/server/standards/README.software.html
  17    especially the note about symlinks.
  18
  19 3) Assuming GNULIB_CHECKOUT refers to a checkout of the gnulib dir,
  20    and      GNULIB_WWW_CHECKOUT refers to the other directory created above (1),
  21    do
  22
  23    GNULIB_WWW_CHECKOUT=`cd $GNULIB_WWW_CHECKOUT && pwd`
  24    cd $GNULIB_CHECKOUT/doc
  25    make updated-stamp
  26    ../build-aux/gendocs.sh -o "$GNULIB_WWW_CHECKOUT/manual" \
  27      gnulib "The GNU Portability Library"
  28    cd $GNULIB_WWW_CHECKOUT
  29
  30    Verify that the result looks sane.
  31
  32 4) Commit the modified and the new files.
  33
  34 5) Find the files which have not been overwritten (because they belonged
  35    to sections that have been removed or renamed):
  36
  37    $ cd manual/html_node
  38    $ ls -lt
  39
  40    Remove these files and commit their removal to CVS.
  41    For each of these files, add a line to the file .symlinks. This will
  42    ensure that hyperlinks to the removed files will redirect to the entire
  43    manual; this is better than a 404 error.
  44
  45 There is a problem with 'index.html' being written twice (once for POSIX
  46 function 'index', once for the table of contents); you can ignore this issue.