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    https://www.gnu.org/server/standards/gnu-website-guidelines.html
  16    especially the note about symlinks.
  17    Some of this page may also be relevant:
  18    https://www.gnu.org/server/standards/README.webmastering.html
  19
  20 3) Assuming GNULIB_CHECKOUT refers to a checkout of the gnulib dir,
  21    and      GNULIB_WWW_CHECKOUT refers to the other directory created above (1),
  22    do
  23
  24    GNULIB_WWW_CHECKOUT=`cd $GNULIB_WWW_CHECKOUT && pwd`
  25    cd $GNULIB_WWW_CHECKOUT
  26    tar -cf html-CVS.tar manual/html_node/CVS manual/html_node/.symlinks
  27    cd $GNULIB_CHECKOUT/doc
  28    make updated-stamp
  29    ../build-aux/gendocs.sh \
  30      -I ../build-aux \
  31      --email bug-gnulib@gnu.org \
  32      -o "$GNULIB_WWW_CHECKOUT/manual" \
  33      gnulib "The GNU Portability Library"
  34    cd $GNULIB_WWW_CHECKOUT
  35    tar -xf html-CVS.tar
  36    rm html-CVS.tar
  37
  38    Run 'cvs diff -u' and verify that the output looks sane.
  39
  40 4) Commit the modified and the new files.
  41
  42 5) Find the files which have not been overwritten (because they belonged
  43    to sections that have been removed or renamed):
  44
  45    $ cd manual/html_node
  46    $ ls -lt
  47
  48    Remove these files and commit their removal to CVS.
  49    For each of these files, add a line to the file .symlinks. This will
  50    ensure that hyperlinks to the removed files will redirect to the entire
  51    manual; this is better than a 404 error.
  52
  53 There is a problem with 'index.html' being written twice (once for POSIX
  54 function 'index', once for the table of contents); you can ignore this issue.
  55
  56 Note: For updating the www.gnu.org pages of *other* GNU packages, package
  57 specific scripts can be used, or build-aux/gnu-web-doc-update may possibly
  58 work.