Skip to content

Commit

Permalink
README: point to tests/bison, and document --trace
Browse files Browse the repository at this point in the history
Reported by Victor Morales Cayuela.

* README, README-hacking.md: here.
  • Loading branch information
akimd committed Mar 5, 2020
1 parent 2353ce7 commit ecd9220
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 1 deletion.
5 changes: 5 additions & 0 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
17 changes: 16 additions & 1 deletion README-hacking.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit ecd9220

Please sign in to comment.