aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorGravatar Abhishek Arya <inferno@chromium.org>2017-04-03 08:20:11 -0700
committerGravatar GitHub <noreply@github.com>2017-04-03 08:20:11 -0700
commitd04cf77f04fc8ef022f9429f6729c22da9af43c2 (patch)
tree930e6e53d6e15b00ac364b0628975eddce9d2861 /docs
parentbf0830a281287319e21560ecc4efb1a933afea41 (diff)
Update docs with new --sanitizer flag, fixes #488. (#505)
Diffstat (limited to 'docs')
-rw-r--r--docs/new_project_guide.md2
-rw-r--r--docs/reference.md2
-rw-r--r--docs/reproducing.md6
3 files changed, 5 insertions, 5 deletions
diff --git a/docs/new_project_guide.md b/docs/new_project_guide.md
index 929f5d18..6f96d0f2 100644
--- a/docs/new_project_guide.md
+++ b/docs/new_project_guide.md
@@ -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`
diff --git a/docs/reference.md b/docs/reference.md
index e5930191..69a184e9 100644
--- a/docs/reference.md
+++ b/docs/reference.md
@@ -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:
diff --git a/docs/reproducing.md b/docs/reproducing.md
index 2e7f0e15..258a7dbb 100644
--- a/docs/reproducing.md
+++ b/docs/reproducing.md
@@ -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>
```