diff options
| author | Akim Demaille <akim.demaille@gmail.com> | 2020-03-04 08:19:37 +0100 |
|---|---|---|
| committer | Akim Demaille <akim.demaille@gmail.com> | 2020-03-05 17:56:55 +0100 |
| commit | ecd922024ed22d6bc0383cdadee7a3298761759d (patch) | |
| tree | 39d89f52b33df3d3285e4a9084b0727a52d94ec9 /README-hacking.md | |
| parent | 2353ce721637c7a2e42bb384beb1d6fd7ece4aa5 (diff) | |
| download | bison-ecd922024ed22d6bc0383cdadee7a3298761759d.tar.gz | |
README: point to tests/bison, and document --trace
Reported by Victor Morales Cayuela.
* README, README-hacking.md: here.
Diffstat (limited to 'README-hacking.md')
| -rw-r--r-- | README-hacking.md | 17 |
1 files changed, 16 insertions, 1 deletions
diff --git a/README-hacking.md b/README-hacking.md index f6b3ee6c..2fbca3bc 100644 --- a/README-hacking.md +++ b/README-hacking.md @@ -34,13 +34,28 @@ 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. -## Horizontal tabs +## Coding style +Follow the GNU Coding Standards. + +Don't reinvent the wheel: we use gnulib, which features many components. +Actually, Bison has legacy code that we should replace with gnulib modules +(e.g., many adhoc implementations of lists). + 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. +## Commit messages +Please, imitate the style we use. Use `git log` to get sources of +inspiration. + +## Debugging +Bison supports tracing of its various steps, via the `--trace` option. +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`. # Working from the repository |