Merge remote-tracking branch 'origin/maint'

[bison.git] / README-hacking

diff --git a/README-hacking b/README-hacking
index b3364ac3911563eaa5642773f2bf1d19962f56eb..2b92edcf0c7c1ae97f4b3799a594da35a9c9bd9e 100644 (file)
--- a/README-hacking
+++ b/README-hacking
@@ -1,5 +1,3 @@
--*- outline -*-
-

 This file attempts to describe the rules to use when hacking Bison.
 Don't put this file into the distribution.
 
 This file attempts to describe the rules to use when hacking Bison.
 Don't put this file into the distribution.
 


@@ -37,6 +35,13 @@ of the .output file etc.  This excludes impossible error messages
 (comparable to assert/abort), and all the --trace output which is
 meant for the maintainers only.
 
 (comparable to assert/abort), and all the --trace output which is
 meant for the maintainers only.
 

+** Horizontal tabs
+Do not add horizontal tab characters to any file in Bison's repository
+except where required.  For example, do not use tabs to format C code.
+However, make files, ChangeLog, and some regular expressions require
+tabs.  Also, test cases might need to contain tabs to check that Bison
+properly processes tabs in its input.
+

 
 * Working from the repository
 
 
 * Working from the repository
 


@@ -60,8 +65,8 @@ tools we depend upon, including:
 - Rsync <http://samba.anu.edu.au/rsync/>
 - Tar <http://www.gnu.org/software/tar/>
 
 - Rsync <http://samba.anu.edu.au/rsync/>
 - Tar <http://www.gnu.org/software/tar/>
 

-Valgrind <http://valgrind.org/> is also highly recommended, if
-Valgrind supports your architecture.
+Valgrind <http://valgrind.org/> is also highly recommended, if it supports
+your architecture.

 
 Bison is written using Bison grammars, so there are bootstrapping
 issues.  The bootstrap script attempts to discover when the C code
 
 Bison is written using Bison grammars, so there are bootstrapping
 issues.  The bootstrap script attempts to discover when the C code


@@ -124,7 +129,7 @@ import requests for updated submodules.  A simple "git diff" will
 reveal if the current version of the submodule (i.e., the actual
 contents of the gnulib directory) and the current request from the
 subscriber (i.e., the reference of the version of gnulib that the
 reveal if the current version of the submodule (i.e., the actual
 contents of the gnulib directory) and the current request from the
 subscriber (i.e., the reference of the version of gnulib that the

-Bison reporitory requests) differ.  To upgrade the submodules (i.e.,
+Bison repository requests) differ.  To upgrade the submodules (i.e.,

 to check out the version that is actually requested by the subscriber,
 run "git submodule update".
 
 to check out the version that is actually requested by the subscriber,
 run "git submodule update".
 


@@ -155,7 +160,7 @@ formal release, see the ChangeLog in the latest gnulib snapshot at:
 
         http://erislabs.net/ianb/projects/gnulib/
 
 
         http://erislabs.net/ianb/projects/gnulib/
 

-The autoconf files we use are currently:
+The Autoconf files we use are currently:

 
         m4/m4.m4
         lib/m4sugar/m4sugar.m4
 
         m4/m4.m4
         lib/m4sugar/m4sugar.m4


@@ -170,6 +175,23 @@ decide whether to update.
 ** make check
 Use liberally.
 
 ** make check
 Use liberally.
 

+** make maintainer-check-valgrind
+This target uses valgrind both to check bison, and the generated parsers.
+
+This is not mature on Mac OS X.  First, Valgrind does support the way bison
+calls m4, so Valgrind cannot be used to check bison on Mac OS X.
+
+Second, there are many errors that come from the platform itself, not from
+bison.  build-aux/darwin11.4.0.valgrind addresses some of them.
+
+Third, valgrind issues warnings such as:
+
+  --99312:0:syswrap- WARNING: Ignoring sigreturn( ..., UC_RESET_ALT_STACK );
+
+which cause the test to fail uselessly.  It is hard to ignore these errors
+with a major overhaul of the way instrumentation is performed in the test
+suite.  So currently, do not try to run valgrind on Mac OS X.
+

 ** Release checks
 Try to run the test suite with more severe conditions before a
 release:
 ** Release checks
 Try to run the test suite with more severe conditions before a
 release:


@@ -211,6 +233,9 @@ release:
   that it does not make sense for glr.c, which should be ANSI, but
   currently is actually GNU C, nor for lalr1.cc.
 
   that it does not make sense for glr.c, which should be ANSI, but
   currently is actually GNU C, nor for lalr1.cc.
 

+- Test with a very recent version of GCC for both C and C++.  Testing
+  with older versions that are still in use is nice too.
+

 
 * Release Procedure
 This section needs to be updated to take into account features from
 
 * Release Procedure
 This section needs to be updated to take into account features from


@@ -248,25 +273,13 @@ copyright statement for each Bison file, check the copyright statements
 that the skeletons insert into generated parsers, and check all
 occurrences of PACKAGE_COPYRIGHT_YEAR in configure.ac.
 
 that the skeletons insert into generated parsers, and check all
 occurrences of PACKAGE_COPYRIGHT_YEAR in configure.ac.
 

-** Update NEWS
-The version number, *and* the date of the release (including for
-betas).
-
-** Mention the release name in a commit message
-Should have an entry similar to "Version 2.3b.".
-
-** Tag the release
-Before Bison will build with the right version number, you must tag
-the release in git.  Do this after all other changes.  The command is
-similar to:
-
-  git tag -a v2.3b -m "Bison 2.3b."
+** Update NEWS, commit and tag.
+See do-release-commit-and-tag in README-release.  For a while, we used
+beta names such as "2.6_rc1".  Now that we use gnulib in the release
+procedure, we must use "2.5.90", which has the additional benefit of
+being properly sorted in "git tag -l".

 
 

-** Push
-Once "make distcheck" passes, push your changes and the tag.
-"git push" without arguments will not push the tag.
-
-** make alpha, beta, or release
+** make alpha, beta, or stable

 See README-release.
 
 ** Upload
 See README-release.
 
 ** Upload


@@ -287,8 +300,8 @@ where F125BDF3 should be replaced with your key ID.
 *** Using gnupload
 You need "ncftp".
 
 *** Using gnupload
 You need "ncftp".
 

-At the end "make release" (or alpha/beta) will display the prodecure
-to run.  Just copy and paste it in your shell.
+At the end "make stable" (or alpha/beta) will display the procedure to
+run.  Just copy and paste it in your shell.

 
 *** By hand
 
 
 *** By hand
 


@@ -359,7 +372,8 @@ function 'index', once for the table of contents); you can ignore this
 issue.
 
 ** Announce
 issue.
 
 ** Announce

-To generate a template announcement file:
+The "make stable" (or alpha/beta) command just created a template,
+$HOME/announce-bison-X.Y.  Otherwise, to generate it, run:

 
   make RELEASE_TYPE=alpha gpg_key_ID=F125BDF3 announcement
 
 
   make RELEASE_TYPE=alpha gpg_key_ID=F125BDF3 announcement
 


@@ -379,15 +393,15 @@ newsgroup by sending email to compilers@iecc.com.  Do not make any Cc as
 the moderator will throw away anything cross-posted or Cc'ed.  It really
 needs to be a separate message.
 
 the moderator will throw away anything cross-posted or Cc'ed.  It really
 needs to be a separate message.
 

-** Bump the version number
-In configure.ac.  Run "make".  So that developers don't accidentally add new
-items to the old NEWS entry, create a new empty NEWS entry something like:
+** Prepare NEWS
+So that developers don't accidentally add new items to the old NEWS
+entry, create a new empty entry in line 3 (without the two leading
+spaces):

 
 

-  Changes in version ?.? (????-??-??):
+  * Noteworthy changes in release ?.? (????-??-??) [?]

 
 Push these changes.
 
 
 Push these changes.
 

-

 -----
 
 Copyright (C) 2002-2005, 2007-2012 Free Software Foundation, Inc.
 -----
 
 Copyright (C) 2002-2005, 2007-2012 Free Software Foundation, Inc.


@@ -406,3 +420,14 @@ GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.

+
+ LocalWords:  Automake Autoconf Gettext Gzip Rsync Valgrind gnulib submodules
+ LocalWords:  submodule init cd distcheck checkin ChangeLog valgrind sigreturn
+ LocalWords:  UC gcc DGNULIB POSIXCHECK xml XSLT glr lalr README po runtime rc
+ LocalWords:  gnupload gnupg gpg keyserver BDF ncftp filename clearsign cvs dir
+ LocalWords:  symlinks vti html lt POSIX Cc'ed
+
+Local Variables:
+mode: outline
+fill-column: 76
+End: