Skip to content

Commit d04cf77

Browse files
Update docs with new --sanitizer flag, fixes google#488. (google#505)
1 parent bf0830a commit d04cf77

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

docs/new_project_guide.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ Use the helper script to build docker image and [fuzz targets](glossary.md#fuzz-
156156
```bash
157157
$ cd /path/to/oss-fuzz
158158
$ python infra/helper.py build_image $PROJECT_NAME
159-
$ python infra/helper.py build_fuzzers --sanitizer=<address/memory/undefined> $PROJECT_NAME
159+
$ python infra/helper.py build_fuzzers --sanitizer <address/memory/undefined> $PROJECT_NAME
160160
```
161161

162162
This should place the built binaries into `/path/to/oss-fuzz/build/out/$PROJECT_NAME`

docs/reference.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Fuzzers are usually built with one or more [sanitizer](https://github.com/googl
66
You can select sanitizer configuration by specifying `$SANITIZER` build environment variable using `-e` option:
77

88
```bash
9-
python infra/helper.py build_fuzzers -e SANITIZER=undefined json
9+
python infra/helper.py build_fuzzers --sanitizer undefined json
1010
```
1111

1212
Supported sanitizers:

docs/reproducing.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ to replicate the exact build steps used by OSS-Fuzz and then feed the reproducer
3131
- *Reproduce using latest OSS-Fuzz build:*
3232

3333
```bash
34-
$ python infra/helper.py build_fuzzers -e SANITIZER=<address/memory/undefined> $PROJECT_NAME
34+
$ python infra/helper.py build_fuzzers --sanitizer <address/memory/undefined> $PROJECT_NAME
3535
$ python infra/helper.py reproduce $PROJECT_NAME <fuzz_target_name> <testcase_path>
3636
```
3737

@@ -42,14 +42,14 @@ $ python infra/helper.py reproduce $PROJECT_NAME <fuzz_target_name> <testcase_pa
4242
and reproduce a crash testcase for a fuzzer named `libxml2_xml_read_memory_fuzzer`, it will be:
4343

4444
```bash
45-
$ python infra/helper.py build_fuzzers -e SANITIZER=undefined libxml2
45+
$ python infra/helper.py build_fuzzers --sanitizer undefined libxml2
4646
$ python infra/helper.py reproduce libxml2 libxml2_xml_read_memory_fuzzer ~/Downloads/testcase
4747
```
4848

4949
- *Reproduce using local source checkout:*
5050

5151
```bash
52-
$ python infra/helper.py build_fuzzers -e SANITIZER=<address/memory/undefined> $PROJECT_NAME <source_path>
52+
$ python infra/helper.py build_fuzzers --sanitizer <address/memory/undefined> $PROJECT_NAME <source_path>
5353
$ python infra/helper.py reproduce $PROJECT_NAME <fuzz_target_name> <testcase_path>
5454
```
5555

0 commit comments

Comments
 (0)