From 5bc993d947cf23057d9f0e2706ea32e89762f718 Mon Sep 17 00:00:00 2001 From: "Joel E. Denny" Date: Fri, 3 Apr 2009 18:32:02 -0400 Subject: [PATCH] Help with updating web manual. * HACKING: Incorporate instructions from gnulib/doc/README. * bootstrap.conf (gnulib_modules): Add gendocs. --- ChangeLog | 10 ++++++++-- HACKING | 41 +++++++++++++++++++++++++++++++++++++++++ bootstrap.conf | 14 +++++++------- build-aux/.cvsignore | 1 + build-aux/.gitignore | 1 + doc/.cvsignore | 5 +++-- doc/.gitignore | 5 +++-- 7 files changed, 64 insertions(+), 13 deletions(-) diff --git a/ChangeLog b/ChangeLog index e0c738b9..1b7afc4c 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +2009-04-03 Joel E. Denny + + Help with updating web manual. + * HACKING: Incorporate instructions from gnulib/doc/README. + * bootstrap.conf (gnulib_modules): Add gendocs. + 2009-04-03 Joel E. Denny Fix strange %define locations for default values. @@ -44,7 +50,7 @@ doc: merge HACKING and README-hacking. Two files is confusing. Reported by Alexandre Duret-Lutz. - + * README-hacking: Merge into... * HACKING (Working from the repository): here. @@ -77,7 +83,7 @@ Fix grep portability issues. Grep on Solaris does not support -q. Reported by Summum Bonum. - + * NEWS: Add a stub for 2.4.2. * THANKS: Add Summum Bonum. * tests/atlocal.in (EGREP): New. diff --git a/HACKING b/HACKING index 16dff1a5..82f07bb4 100644 --- a/HACKING +++ b/HACKING @@ -283,6 +283,47 @@ Here's a brief reminder of how to roll the tarballs and upload them: *** put bison-2.3b.tar.gz.directive.asc *** Repeat all these steps for bison-2.3b.tar.bz2. +** Update Bison manual on www.gnu.org. + +*** You need a non-anonymous checkout of the web pages directory. + + $ cvs -d YOUR_USERID@cvs.savannah.gnu.org:/web/bison checkout bison + +*** 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. + +*** Build the web pages. +Assuming BISON_CHECKOUT refers to a checkout of the Bison dir, and +BISON_WWW_CHECKOUT refers to the web directory created above, do: + + $ cd $BISON_CHECKOUT/doc + $ make stamp-vti + $ ../build-aux/gendocs.sh -o "$BISON_WWW_CHECKOUT/manual" \ + bison "Bison - GNU parser generator" + $ cd $BISON_WWW_CHECKOUT + +Verify that the result looks sane. + +*** Commit the modified and the new files. + +*** Remove old files. +Find the files which have not been overwritten (because they belonged to +sections that have been removed or renamed): + + $ cd manual/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. + ** Announce To generate a template announcement file: diff --git a/bootstrap.conf b/bootstrap.conf index bcab1b89..c7596c17 100644 --- a/bootstrap.conf +++ b/bootstrap.conf @@ -1,6 +1,6 @@ # Bootstrap configuration. -# Copyright (C) 2006, 2007, 2008 Free Software Foundation, Inc. +# Copyright (C) 2006, 2007, 2008, 2009 Free Software Foundation, Inc. # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by @@ -17,12 +17,12 @@ # gnulib modules used by this package. gnulib_modules=' - announce-gen argmatch config-h c-strcase configmake - dirname error extensions fopen-safer getopt gettext git-version-gen - gnumakefile hash inttypes javacomp-script javaexec-script malloc - mbswidth obstack quote quotearg stdbool stpcpy strerror strtoul - strverscmp unistd unistd-safer unlocked-io unsetenv verify - warnings xalloc xalloc-die xstrndup + announce-gen argmatch config-h c-strcase configmake dirname error + extensions fopen-safer gendocs getopt gettext git-version-gen + gnumakefile hash inttypes javacomp-script javaexec-script malloc + mbswidth obstack quote quotearg stdbool stpcpy strerror strtoul + strverscmp unistd unistd-safer unlocked-io unsetenv verify warnings + xalloc xalloc-die xstrndup ' # Additional xgettext options to use. Use "\\\newline" to break lines. diff --git a/build-aux/.cvsignore b/build-aux/.cvsignore index 2edd4b15..771f0efc 100644 --- a/build-aux/.cvsignore +++ b/build-aux/.cvsignore @@ -6,6 +6,7 @@ config.guess config.rpath config.sub depcomp +gendocs.sh git-version-gen install-sh javacomp.sh.in diff --git a/build-aux/.gitignore b/build-aux/.gitignore index db9bb9f6..29d77959 100644 --- a/build-aux/.gitignore +++ b/build-aux/.gitignore @@ -6,6 +6,7 @@ /config.rpath /config.sub /depcomp +/gendocs.sh /git-version-gen /install-sh /javacomp.sh.in diff --git a/doc/.cvsignore b/doc/.cvsignore index 0376b3e7..28087990 100644 --- a/doc/.cvsignore +++ b/doc/.cvsignore @@ -1,4 +1,6 @@ +*.info* Makefile +Makefile.in bison.1 bison.aux bison.cp @@ -15,11 +17,10 @@ bison.toc bison.tp bison.vr cross-options.texi -Makefile.in +gendocs_template refcard.dvi refcard.log refcard.ps -*.info* stamp-vti version.texi yacc.1 diff --git a/doc/.gitignore b/doc/.gitignore index 1d55073d..341c2b19 100644 --- a/doc/.gitignore +++ b/doc/.gitignore @@ -1,4 +1,6 @@ +/*.info* /Makefile +/Makefile.in /bison.1 /bison.aux /bison.cp @@ -15,11 +17,10 @@ /bison.tp /bison.vr /cross-options.texi -/Makefile.in +/gendocs_template /refcard.dvi /refcard.log /refcard.ps -/*.info* /stamp-vti /version.texi /yacc.1 -- 2.45.2