Add documentation about dictionaries and custom options.

This commit is contained in:
Oliver Chang 2016-08-30 14:20:32 -07:00
parent 0acb53d535
commit 4e20e344d2
1 changed files with 17 additions and 0 deletions

View File

@ -118,6 +118,22 @@ Breaking this down:
and `.libs/libexpat.a` (which we just built). and `.libs/libexpat.a` (which we just built).
### Dictionaries and custom libfuzzer options
Any top-level files in the library directory ending with the extension ".dict"
or ".options" will be picked up by ClusterFuzz. Files ending with ".dict" are
assumed to be libFuzzer compatible [dictionaries], and .options files have the
format:
```
[libfuzzer]
dict = dictionary_name.dict
max_len = 9001
```
This means that `-dict=/path/to/dictionary_name.dict` and `-max_len=9001` will
be passed to the fuzzer when it's run.
### Others (e.g. fuzzer source) ### Others (e.g. fuzzer source)
For some libraries, the upstream repository will contain fuzzers (e.g. For some libraries, the upstream repository will contain fuzzers (e.g.
@ -184,3 +200,4 @@ Once your change is merged, the fuzzers should be automatically built and run on
ClusterFuzz after a short while! ClusterFuzz after a short while!
[oss-fuzz repo]: https://github.com/google/oss-fuzz [oss-fuzz repo]: https://github.com/google/oss-fuzz
[dictionaries]: http://llvm.org/docs/LibFuzzer.html#dictionaries