Skip to content

Commit ecd9220

Browse files
committed
README: point to tests/bison, and document --trace
Reported by Victor Morales Cayuela. * README, README-hacking.md: here.
1 parent 2353ce7 commit ecd9220

File tree

2 files changed

+21
-1
lines changed

2 files changed

+21
-1
lines changed

README

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,11 @@ See the file INSTALL for generic compilation and installation instructions.
1717
Bison requires GNU m4 1.4.6 or later. See
1818
https://ftp.gnu.org/gnu/m4/m4-1.4.6.tar.gz.
1919

20+
## Running a non installed bison
21+
Once you ran `make`, you might want to toy with this fresh bison before
22+
installing it. In that case, do not use `src/bison`: it would use the
23+
*installed* files (skeletons, etc.), not the local ones. Use `tests/bison`.
24+
2025
## Colored diagnostics
2126
As an experimental feature, diagnostics are now colored, controlled by the
2227
`--color` and `--style` options.

README-hacking.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,28 @@ Only user visible strings are to be translated: error messages, bits of the
3434
assert/abort), and all the --trace output which is meant for the maintainers
3535
only.
3636

37-
## Horizontal tabs
37+
## Coding style
38+
Follow the GNU Coding Standards.
39+
40+
Don't reinvent the wheel: we use gnulib, which features many components.
41+
Actually, Bison has legacy code that we should replace with gnulib modules
42+
(e.g., many adhoc implementations of lists).
43+
3844
Do not add horizontal tab characters to any file in Bison's repository
3945
except where required. For example, do not use tabs to format C code.
4046
However, make files, ChangeLog, and some regular expressions require tabs.
4147
Also, test cases might need to contain tabs to check that Bison properly
4248
processes tabs in its input.
4349

50+
## Commit messages
51+
Please, imitate the style we use. Use `git log` to get sources of
52+
inspiration.
53+
54+
## Debugging
55+
Bison supports tracing of its various steps, via the `--trace` option.
56+
Since it is not meant for the end user, it is not displayed by `bison
57+
--help`, nor is it documented in the manual. Instead, run `bison
58+
--trace=help`.
4459

4560
# Working from the repository
4661

0 commit comments

Comments
 (0)