doc: help Doxygen find our files.

[bison.git] / README-hacking

diff --git a/README-hacking b/README-hacking
index 759e08c51002aba7e13e2f861081d293fa777611..f79a31a8f57b25f101c37d69b55a353667b93be0 100644 (file)
--- a/README-hacking
+++ b/README-hacking
@@ -46,6 +46,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
 


@@ -158,6 +165,20 @@ Register your changes.
 
         $ git checkin ...
 
 
         $ git checkin ...
 

+For a suggestion of what gnulib commit might be stable enough for a
+formal release, see the ChangeLog in the latest gnulib snapshot at:
+
+        http://erislabs.net/ianb/projects/gnulib/
+
+The autoconf files we use are currently:
+
+        m4/m4.m4
+        lib/m4sugar/m4sugar.m4
+        lib/m4sugar/foreach.m4
+
+These files don't change very often in autoconf, so it should be
+relatively straight-forward to examine the differences in order to
+decide whether to update.

 
 * Test suite
 
 
 * Test suite
 


@@ -197,9 +218,16 @@ 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
 
 
 * Release Procedure
 

+** Update the submodules.  See above.
+
+** Update maintainer tools, such as Autoconf.  See above.
+

 ** Try to get the *.pot files to the Translation Project at least one
 week before a stable release, to give them time to translate them.
 Before generating the *.pot files, make sure that po/POTFILES.in and
 ** Try to get the *.pot files to the Translation Project at least one
 week before a stable release, to give them time to translate them.
 Before generating the *.pot files, make sure that po/POTFILES.in and


@@ -292,7 +320,7 @@ Here's a brief reminder of how to roll the tarballs and upload them:
 *** put bison-2.3b.tar.gz # This can take a while.
 *** put bison-2.3b.tar.gz.sig
 *** put bison-2.3b.tar.gz.directive.asc
 *** put bison-2.3b.tar.gz # This can take a while.
 *** put bison-2.3b.tar.gz.sig
 *** put bison-2.3b.tar.gz.directive.asc

-*** Repeat all these steps for bison-2.3b.tar.bz2.
+*** Repeat all these steps for bison-2.3b.tar.xz.

 
 ** Update Bison manual on www.gnu.org.
 
 
 ** Update Bison manual on www.gnu.org.
 


@@ -367,8 +395,7 @@ Push these changes.
 
 -----
 
 
 -----
 

-Copyright (C) 2002, 2003, 2004, 2005, 2007, 2008, 2009, 2010 Free
-Software Foundation, Inc.
+Copyright (C) 2002-2005, 2007-2012 Free Software Foundation, Inc.

 
 This file is part of GNU Bison.
 
 
 This file is part of GNU Bison.