summaryrefslogtreecommitdiff
path: root/README-hacking.md
diff options
context:
space:
mode:
authorAkim Demaille <akim.demaille@gmail.com>2020-11-01 15:32:24 +0100
committerAkim Demaille <akim.demaille@gmail.com>2020-11-03 08:46:54 +0100
commit042b916c0e5ddafc8cd513c38f2d79f794d2446c (patch)
treeec072707547d3710c173456a7ca4451efa3d11dc /README-hacking.md
parent57848d92628d960f57db96902dfcac4d6b536bcf (diff)
downloadbison-042b916c0e5ddafc8cd513c38f2d79f794d2446c.tar.gz
style: comment changes in the skeletons
* data/skeletons/lalr1.cc: Prepare for Java's LAC. * data/skeletons/lalr1.java: Style fixes.
Diffstat (limited to 'README-hacking.md')
-rw-r--r--README-hacking.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/README-hacking.md b/README-hacking.md
index 9c5d9a3e..d7e749f7 100644
--- a/README-hacking.md
+++ b/README-hacking.md
@@ -346,12 +346,14 @@ and [Google Java Style
Guide](https://google.github.io/styleguide/javaguide.html). Unfortunately
at some point some GNU Coding Style was installed in Java, but it's an
error. So we should for instance stop putting spaces in function calls.
-Because we are standardizing the code, it is currently inconsistent.
+Because we are standardizing the code, it is currently inconsistent. Treat
+acronyms as words: `YYLacStack`, not `YYLACStack`.
Use a 2-space indentation (Google) rather than 4 (Oracle).
-Don't use the "yy" prefix for public members: "getExpectedTokens", not
-"yyexpectedTokens" or "yygetExpectedTokens".
+Don't use the `yy` prefix for public members: `getExpectedTokens`, not
+`yyexpectedTokens` or `yygetExpectedTokens`. Keep the `yy` prefix though
+for private details.
## Commit Messages
Imitate the style we use. Use `git log` to get sources of inspiration.