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/readme_index.html
  16    https://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_WWW_CHECKOUT
  25    tar -cf html-CVS.tar manual/html_node/CVS manual/html_node/.symlinks
  26    cd $GNULIB_CHECKOUT/doc
  27    make updated-stamp
  28    ../build-aux/gendocs.sh \
  29      -I ../build-aux \
  30      --email bug-gnulib@gnu.org \
  31      -o "$GNULIB_WWW_CHECKOUT/manual" \
  32      gnulib "The GNU Portability Library"
  33    cd $GNULIB_WWW_CHECKOUT
  34    tar -xf html-CVS.tar
  35    rm html-CVS.tar
  36
  37    Run 'cvs diff -u' and verify that the output looks sane.
  38
  39 4) Commit the modified and the new files.
  40
  41 5) Find the files which have not been overwritten (because they belonged
  42    to sections that have been removed or renamed):
  43
  44    $ cd manual/html_node
  45    $ ls -lt
  46
  47    Remove these files and commit their removal to CVS.
  48    For each of these files, add a line to the file .symlinks. This will
  49    ensure that hyperlinks to the removed files will redirect to the entire
  50    manual; this is better than a 404 error.
  51
  52 There is a problem with 'index.html' being written twice (once for POSIX
  53 function 'index', once for the table of contents); you can ignore this issue.