Re: Web manual out-dated?

[Bruno Haible]

Simon Josefsson wrote:
> I wanted to link to a recent part of the gnulib manual, but noticed the
> online manual is rather old:
> 
> http://www.gnu.org/software/gnulib/manual/
> 
> How was this manual generated?  I may have write access to the web cvs
> repository, is it ok to upload an updated manual, once the way to
> generate it is documented?

Yes. It's with pleasure that I share with you the recipe to update the
manual on the web site.

1) You need a checkout of the texinfo/util directory. (Actually only 2 files
   in this directory are needed.)

   $ cvs -d :pserver:address@hidden:/sources/texinfo \
         checkout texinfo/util

2) You need a non-anonymous checkout of the web pages directory.

   $ cvs -d :ext:address@hidden:/web/gnulib \
         checkout gnulib

3) Get familiar with the instructions for web page maintainers.
   http://www.gnu.org/server/standards/readme_index.html
   http://www.gnu.org/server/standards/README.software.html
   especially the note about symlinks.

4) Assuming GNULIB_CHECKOUT refers to a checkout of the gnulib dir,
   and      TEXINFO_UTIL_CHECKOUT refers to the directory created above (1),
   and      GNULIB_WWW_CHECKOUT refers to the other directory created above (2),
   do

   GNULIB_WWW_CHECKOUT=`cd $GNULIB_WWW_CHECKOUT && pwd`
   cd $GNULIB_CHECKOUT
   $TEXINFO_UTIL_CHECKOUT/gendocs.sh -o "$GNULIB_WWW_CHECKOUT/manual" \
     gnulib "The GNU Portability Library"
   cd $GNULIB_WWW_CHECKOUT

   Verify that the result looks sane.

5) Commit the modified and the new files.

6) Find the files which have not been overwritten (because they belonged
   to sections that have been removed or renamed):

   $ cd html_node
   $ ls -lt

   Remove these files and commit their removal to CVS.
   For each of these files, add a line to the file .symlinks. This will
   ensure that hyperlinks to the removed files will redirect to the entire
   manual; this is better than a 404 error.

There is a problem with 'index.html' being written twice (once for POSIX
function 'index', once for the table of contents); you can ignore this issue.

Bruno