diff --git a/README b/README index f18958a14..f8d797551 100644 --- a/README +++ b/README @@ -17,6 +17,11 @@ See the file INSTALL for generic compilation and installation instructions. Bison requires GNU m4 1.4.6 or later. See https://ftp.gnu.org/gnu/m4/m4-1.4.6.tar.gz. +## Running a non installed bison +Once you ran `make`, you might want to toy with this fresh bison before +installing it. In that case, do not use `src/bison`: it would use the +*installed* files (skeletons, etc.), not the local ones. Use `tests/bison`. + ## Colored diagnostics As an experimental feature, diagnostics are now colored, controlled by the `--color` and `--style` options. diff --git a/README-hacking.md b/README-hacking.md index f6b3ee6cf..2fbca3bc5 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