diff options
| author | Nick Fitzgerald <fitzgen@gmail.com> | 2017-10-05 10:26:00 -0700 |
|---|---|---|
| committer | Nick Fitzgerald <fitzgen@gmail.com> | 2017-10-05 10:51:39 -0700 |
| commit | a25a2f66ba160862f33c76bdb292c7fd42669eaf (patch) | |
| tree | 1f09af52149d25f1795a99b846d09dc88447d135 | |
| parent | e03d6fa3a9e59b66b85c547daf84f969dca384df (diff) | |
Add a blurb about C-Smith fuzzing to CONTRIBUTING.md
And link to the csmith-fuzzing/README.md file for more details.
Fixes #1038
| -rw-r--r-- | CONTRIBUTING.md | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 49eacc1b..a3562c8b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,6 +19,7 @@ out to us in a GitHub issue, or stop by - [Testing a Single Header's Bindings Generation and Compiling its Bindings](#testing-a-single-headers-bindings-generation-and-compiling-its-bindings) - [Authoring New Tests](#authoring-new-tests) - [Test Expectations and `libclang` Versions](#test-expectations-and-libclang-versions) + - [Fuzzing `bindgen` with `csmith`](#fuzzing-bindgen-with-csmith) - [Code Overview](#code-overview) - [Pull Requests and Code Reviews](#pull-requests-and-code-reviews) - [Generating Graphviz Dot Files](#generating-graphviz-dot-files) @@ -193,6 +194,14 @@ Where `$VERSION` is one of: depending on which version of `libclang` you have installed. +### Fuzzing `bindgen` with `csmith` + +We <3 finding hidden bugs and the people who help us find them! One way to help +uncover hidden bugs is by running `csmith` to generate random headers to test +`bindgen` against. + +See [./csmith-fuzzing/README.md](./csmith-fuzzing/README.md) for details. + ## Code Overview `bindgen` takes C and C++ header files as input and generates corresponding Rust |