doc: style fixes

[bison.git] / README-hacking

diff --git a/README-hacking b/README-hacking
index 11b9f82a39fc78dccec2e8f2f179bd380ddbe8c6..716801003d097305624933d4f57058c262de3ba1 100644 (file)
--- a/README-hacking
+++ b/README-hacking
@@ -35,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
 


@@ -169,6 +176,28 @@ decide whether to update.
 ** make check
 Use liberally.
 
 ** make check
 Use liberally.
 

+** TESTSUITEFLAGS
+
+The default is for make check to run all tests sequentially. This can be
+very time consumming when checking repeatedly or on slower setups. This can
+be sped up in two ways:
+
+Using -j, in a make-like fashion, for example:
+  $ make check TESTSUITEFLAGS='-j8'
+
+Running only the tests of a certain category, as specified in the AT files
+with AT_KEYWORDS([[category]]). Categories include:
+  - c++, for c++ parsers
+  - deprec, for tests concerning deprecated constructs.
+  - glr, for glr parsers
+  - java, for java parsers
+  - report, for automaton dumps
+
+To run a specific set of tests, use -k (for "keyword"). For example:
+  $ make check TESTSUITEFLAGS='-k c++'
+
+Both can be combined.
+

 ** Typical errors
 If the test suite shows failures such as the following one
 
 ** Typical errors
 If the test suite shows failures such as the following one
 


@@ -240,6 +269,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