Rooba
/
oss-fuzz
mirror of https://github.com/google/oss-fuzz.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update docs with new --sanitizer flag, fixes #488. (#505)

This commit is contained in:
Abhishek Arya 2017-04-03 08:20:11 -07:00 committed by GitHub
parent bf0830a281
commit d04cf77f04
3 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/new_project_guide.md
View File

@ -156,7 +156,7 @@ Use the helper script to build docker image and [fuzz targets](glossary.md#fuzz-
```bash
$ cd /path/to/oss-fuzz
$ python infra/helper.py build_image $PROJECT_NAME
$ python infra/helper.py build_fuzzers --sanitizer=<address/memory/undefined> $PROJECT_NAME
$ python infra/helper.py build_fuzzers --sanitizer <address/memory/undefined> $PROJECT_NAME
```
This should place the built binaries into `/path/to/oss-fuzz/build/out/$PROJECT_NAME`

2
docs/reference.md
View File

@ -6,7 +6,7 @@ Fuzzers are usually built with one or more [sanitizer](https://github.com/googl
You can select sanitizer configuration by specifying `$SANITIZER` build environment variable using `-e` option:
```bash
python infra/helper.py build_fuzzers -e SANITIZER=undefined json
python infra/helper.py build_fuzzers --sanitizer undefined json
```
Supported sanitizers:

6
docs/reproducing.md
View File

@ -31,7 +31,7 @@ to replicate the exact build steps used by OSS-Fuzz and then feed the reproducer
- *Reproduce using latest OSS-Fuzz build:*
```bash
$ python infra/helper.py build_fuzzers -e SANITIZER=<address/memory/undefined> $PROJECT_NAME
$ python infra/helper.py build_fuzzers --sanitizer <address/memory/undefined> $PROJECT_NAME
$ python infra/helper.py reproduce $PROJECT_NAME <fuzz_target_name> <testcase_path>
```
@ -42,14 +42,14 @@ $ python infra/helper.py reproduce $PROJECT_NAME <fuzz_target_name> <testcase_pa
and reproduce a crash testcase for a fuzzer named `libxml2_xml_read_memory_fuzzer`, it will be:
```bash
$ python infra/helper.py build_fuzzers -e SANITIZER=undefined libxml2
$ python infra/helper.py build_fuzzers --sanitizer undefined libxml2
$ python infra/helper.py reproduce libxml2 libxml2_xml_read_memory_fuzzer ~/Downloads/testcase
```
- *Reproduce using local source checkout:*
```bash
$ python infra/helper.py build_fuzzers -e SANITIZER=<address/memory/undefined> $PROJECT_NAME <source_path>
$ python infra/helper.py build_fuzzers --sanitizer <address/memory/undefined> $PROJECT_NAME <source_path>
$ python infra/helper.py reproduce $PROJECT_NAME <fuzz_target_name> <testcase_path>
```