|
| 1 | +<!-- omit from toc --> |
1 | 2 | # Bazel Rules User Guide
|
2 | 3 |
|
| 4 | +<!-- omit from toc --> |
3 | 5 | ## Contents
|
4 | 6 |
|
5 |
| -* [Defining fuzz tests](#defining-fuzz-tests) |
6 |
| -* [Integrating in your project](#integrating-in-your-project) |
7 |
| -* [Advanced topics](#advanced-topics) |
8 |
| - * [Defining fuzzing engines](#defining-fuzzing-engines) |
9 |
| - * [Customizing fuzz tests](#customizing-fuzz-tests) |
10 |
| -* [Rule reference](#rule-reference) |
| 7 | +- [Defining fuzz tests](#defining-fuzz-tests) |
| 8 | + - [Defining fuzz tests](#defining-fuzz-tests-1) |
| 9 | + - [Building and running](#building-and-running) |
| 10 | + - [Specifying seed corpora](#specifying-seed-corpora) |
| 11 | + - [Specifying dictionaries](#specifying-dictionaries) |
| 12 | + - [The fuzz test launcher](#the-fuzz-test-launcher) |
| 13 | + - [Built-in fuzzing engines](#built-in-fuzzing-engines) |
| 14 | + - [Configuration flags](#configuration-flags) |
| 15 | +- [Integrating in your project](#integrating-in-your-project) |
| 16 | + - [Configuring the .bazelrc file](#configuring-the-bazelrc-file) |
| 17 | +- [Advanced topics](#advanced-topics) |
| 18 | + - [Defining fuzzing engines](#defining-fuzzing-engines) |
| 19 | +- [Rule reference](#rule-reference) |
11 | 20 |
|
12 | 21 | ## Defining fuzz tests
|
13 | 22 |
|
@@ -121,11 +130,11 @@ Currently, the launcher offers the following options:
|
121 | 130 |
|
122 | 131 | * `@rules_fuzzing//fuzzing/engines:libfuzzer` provides libFuzzer support. Must be used with the `libfuzzer` engine instrumentation.
|
123 | 132 |
|
124 |
| -* `@rules_fuzzing//fuzzing/engines:honggfuzz` provides Honggfuzz support. Must be used with the `honggfuzz` engine instrumentation. Requires importing its dependencies using the `honggfuzz_dependencies()` WORKSPACE function. |
| 133 | +* `@rules_fuzzing//fuzzing/engines:honggfuzz` provides Honggfuzz support. Must be used with the `honggfuzz` engine instrumentation. When using WORKSPACE, requires importing its dependencies using the `honggfuzz_dependencies()` WORKSPACE function. |
125 | 134 |
|
126 | 135 | * `@rules_fuzzing//fuzzing/engines:replay` provides a simple engine that just executes a set of test files. It can be combined with a sanitizer and can be used for regression tests or replaying crashes.
|
127 | 136 |
|
128 |
| -* `@rules_fuzzing_oss_fuzz//:oss_fuzz_engine` provides a fuzzing engine that reflects the environment configuration of an [OSS-Fuzz build][bazel-oss-fuzz]. This engine is useful in the `build.sh` script of an OSS-Fuzz project. Requires importing its dependencies using the `oss_fuzz_dependencies()` WORKSPACE function. |
| 137 | +* `@rules_fuzzing//fuzzing/engines:oss_fuzz` and `:oss_fuzz_java` provide fuzzing engines that reflect the environment configuration of an [OSS-Fuzz build][bazel-oss-fuzz]. These engines are useful in the `build.sh` script of an OSS-Fuzz project. When using WORKSPACE, this requires importing its dependencies using the `oss_fuzz_dependencies()` function. |
129 | 138 |
|
130 | 139 | ### Configuration flags
|
131 | 140 |
|
|
0 commit comments