summaryrefslogtreecommitdiff
path: root/README-hacking.md
diff options
context:
space:
mode:
authorAkim Demaille <akim.demaille@gmail.com>2020-04-26 10:13:34 +0200
committerAkim Demaille <akim.demaille@gmail.com>2020-04-26 16:08:42 +0200
commit3aaa97109639ba2a67c0c6a76f893ffddedcb137 (patch)
tree51841e8aaae007c75c6e2f7896db14c1e68131bb /README-hacking.md
parent7eabe1c70bd14ffc19139a61d8b74f565a178a3a (diff)
downloadbison-3aaa97109639ba2a67c0c6a76f893ffddedcb137.tar.gz
doc: hacking tricks
* README-hacking.md: Here.
Diffstat (limited to 'README-hacking.md')
-rw-r--r--README-hacking.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README-hacking.md b/README-hacking.md
index 5e64f95b..4019faa9 100644
--- a/README-hacking.md
+++ b/README-hacking.md
@@ -37,6 +37,14 @@ Only user visible strings are to be translated: error messages, bits of the
assert/abort), and all the --trace output which is meant for the maintainers
only.
+## Syntax highlighting
+It's quite nice to be in C++ mode when editing lalr1.cc for instance.
+However tools such as Emacs will be fooled by the fact that braces and
+parens do not nest, as in `[[}]]`. As a consequence you might be misguided
+by its visual pairing to parens. The m4-mode is safer. Unfortunately the
+m4-mode is also fooled by `#` which is sees as a comment, stops pairing with
+parens/brackets that are inside...
+
## Coding Style
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.
@@ -395,6 +403,12 @@ again, since some early failures may stop latter tests from being run. Yet
at some point, you'll have to fix remaining issues by hand...
+## Running Java parsers
+Use the `javaexec.sh` script. For instance to run the parser of test case
+504:
+
+ $ sh ./_build/javaexec.sh -cp ./_build/tests/testsuite.dir/504 Calc
+
## make maintainer-check-valgrind
This target uses valgrind both to check bison, and the generated parsers.