]> git.saurik.com Git - bison.git/commitdiff
Help with updating web manual.
authorJoel E. Denny <jdenny@ces.clemson.edu>
Fri, 3 Apr 2009 22:32:02 +0000 (18:32 -0400)
committerJoel E. Denny <jdenny@ces.clemson.edu>
Fri, 3 Apr 2009 22:46:58 +0000 (18:46 -0400)
* HACKING: Incorporate instructions from gnulib/doc/README.
* bootstrap.conf (gnulib_modules): Add gendocs.

ChangeLog
HACKING
bootstrap.conf
build-aux/.cvsignore
build-aux/.gitignore
doc/.cvsignore
doc/.gitignore

index e0c738b91dfcb2e4a1c2b0880b438087c0502717..1b7afc4c3831509db8956af7be1799b713302725 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2009-04-03  Joel E. Denny  <jdenny@ces.clemson.edu>
+
+       Help with updating web manual.
+       * HACKING: Incorporate instructions from gnulib/doc/README.
+       * bootstrap.conf (gnulib_modules): Add gendocs.
+
 2009-04-03  Joel E. Denny  <jdenny@ces.clemson.edu>
 
        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 16dff1a59a35d84b4e6bf4d8c53c9df9d4d66e8d..82f07bb4f32fb11b91fbd886b8c88488cbb9f519 100644 (file)
--- 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:
 
index bcab1b89d1206020c58d3254410440d427d5df18..c7596c178994b2e6138791909345254a5e4e2362 100644 (file)
@@ -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
 
 # 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.
index 2edd4b15a921df68b4e5b17b5182fb886302c412..771f0efc994684235eb8e1a8cfc37dd5bf3761d9 100644 (file)
@@ -6,6 +6,7 @@ config.guess
 config.rpath
 config.sub
 depcomp
+gendocs.sh
 git-version-gen
 install-sh
 javacomp.sh.in
index db9bb9f69174b252945fcff3b8028ddfe817cb80..29d779594909548258d67e586815ea392634bdd2 100644 (file)
@@ -6,6 +6,7 @@
 /config.rpath
 /config.sub
 /depcomp
+/gendocs.sh
 /git-version-gen
 /install-sh
 /javacomp.sh.in
index 0376b3e7f34f072afecc76d6aa89406c67bcaa5c..2808799028d68a7570d737034e62d942150a0bf8 100644 (file)
@@ -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
index 1d55073d17ca7a8cdbaa6e343d2019985c9950d1..341c2b193225978ef1c6400a52c2f4b2f4a70948 100644 (file)
@@ -1,4 +1,6 @@
+/*.info*
 /Makefile
+/Makefile.in
 /bison.1
 /bison.aux
 /bison.cp
 /bison.tp
 /bison.vr
 /cross-options.texi
-/Makefile.in
+/gendocs_template
 /refcard.dvi
 /refcard.log
 /refcard.ps
-/*.info*
 /stamp-vti
 /version.texi
 /yacc.1