diff options
| author | Amanjeev Sethi <aj@amanjeev.com> | 2022-08-11 15:14:23 -0400 |
|---|---|---|
| committer | Darren Kulp <darren@kulp.ch> | 2022-08-11 14:36:22 -0500 |
| commit | 50878f37e639b8c868adec8a8c745e788c2d870a (patch) | |
| tree | ae79499a2a4430e5756419318aced58d0e278b5e | |
| parent | b18bf798bef43c65af98520f9b58b6810aa2b17b (diff) | |
docs(CONTRIBUTING): add a note for single test run
test-one.sh needs to run `dot` command which is installed via Graphviz.
Else, running the script throws error - `dot` command not found.
| -rw-r--r-- | CONTRIBUTING.md | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0ffd5b4f..3fe7539f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -152,6 +152,9 @@ $ cargo test ### Testing a Single Header's Bindings Generation and Compiling its Bindings +Note: You will to need to install [Graphviz](https://graphviz.org/) since that +is a dependency for running `test-one.sh`. + Sometimes its useful to work with one test header from start (generating bindings for it) to finish (compiling the bindings and running their layout tests). This can be done with the `tests/test-one.sh` script. It supports fuzzy |