dnrops
/
tectonic
mirror of https://github.com/tectonic-typesetting/tectonic.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fuzz/README.md: add a brief README

This commit is contained in:
Peter Williams 2019-06-15 15:06:54 -05:00
parent 5ce4f003d0
commit a515f5290d
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
fuzz/README.md Normal file
View File

@ -0,0 +1,24 @@
# Tectonic Fuzzing Support
This is *beta-level* support for [fuzzing] the Tectonic engine using
[cargo-fuzz]. At the moment, the fuzzing does not work very well because it
exposes memory leaks in the Tectonic engine; this is desirable in and of
itself, but the exposed leaks have proven to be tricky to fix. (Patches most
welcome, of course! The limiting factor here is definitely developer
bandwidth.)
See the script `./run-fuzzer.sh` for an example of how to, well, run the
fuzzer. Note that this script sets a [rustup directory override] to build
Tectonic using the nightly compilers, since nightly is currently required by
the fuzzer.
To tell the fuzzer to ignore memory leaks, run a command like the following
from the toplevel directory of the Tectonic repository:
```sh
cargo +nightly fuzz run compile fuzz/corpus fuzz/seeds -- -detect_leaks=0
```
[fuzzing]: https://en.wikipedia.org/wiki/Fuzzing
[cargo-fuzz]: https://github.com/rust-fuzz/cargo-fuzz
[rustup directory override]: https://github.com/rust-lang/rustup.rs#directory-overrides