summaryrefslogtreecommitdiff
path: root/README-hacking.md
diff options
context:
space:
mode:
authorAkim Demaille <akim.demaille@gmail.com>2020-05-23 11:11:45 +0200
committerAkim Demaille <akim.demaille@gmail.com>2020-05-23 11:19:27 +0200
commit3fea8fade8e2fad9e5053ff79af0604c3d119994 (patch)
treed92ee355135e749b5a0f7c61e3692729f3179fee /README-hacking.md
parente7aff571223ee73dd0281a94c510f0196817a8fa (diff)
downloadbison-3fea8fade8e2fad9e5053ff79af0604c3d119994.tar.gz
style: spell fixes
* Makefile.am (codespell): New. * doc/bison.texi: Fixes. Use @option for options. * src/lssi.c, src/lssi.h, src/parse-simulation.h, src/state-item.c: Fix spellos.
Diffstat (limited to 'README-hacking.md')
-rw-r--r--README-hacking.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/README-hacking.md b/README-hacking.md
index 4019faa9..af14dbf0 100644
--- a/README-hacking.md
+++ b/README-hacking.md
@@ -148,6 +148,10 @@ Since it is not meant for the end user, it is not displayed by `bison
--help`, nor is it documented in the manual. Instead, run `bison
--trace=help`.
+## Documentation
+Use `@option` for options and options with their argument if they have no
+space (e.g., `@option{-Dfoo=bar}`). However, use `@samp` elsewhere (e.g.,
+`@samp{-I foo}`).
Working from the Repository