From 5b414908fde951edd403905e9f37c2f23737a869 Mon Sep 17 00:00:00 2001 From: Kostya Serebryany Date: Mon, 15 May 2017 18:44:54 -0700 Subject: [PATCH] Update README.md --- projects/example/my-api-repo/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/projects/example/my-api-repo/README.md b/projects/example/my-api-repo/README.md index 73f28fba3..a170a772c 100644 --- a/projects/example/my-api-repo/README.md +++ b/projects/example/my-api-repo/README.md @@ -8,7 +8,6 @@ Imagine that these files reside in your project's repository: * [my_api.h](my_api.h): and [my_api.cpp](my_api.cpp) implement the API we want to test/fuzz. The function `DoStuff()` inside [my_api.cpp](my_api.cpp) contains a bug. (Find it!) * [do_stuff_unittest.cpp](do_stuff_unittest.cpp): is a unit test for `DoStuff()`. Unit tests are not necessary for fuzzing, but are generally a good practice. * [do_stuff_fuzzer.cpp](do_stuff_fuzzer.cpp): is a [fuzz target](http://libfuzzer.info/#fuzz-target) for `DoStuff()`. -* [standalone_fuzz_taget_runner.cpp](standalone_fuzz_taget_runner.cpp): is a simple standalone runnner for fuzz targets. You may use it to execute a fuzz target on given files w/o having to link in libFuzzer or other fuzzing engine. * [do_stuff_test_data](do_stuff_test_data): corpus directory for [do_stuff_fuzzer.cpp](do_stuff_fuzzer.cpp). * [do_stuff_fuzzer.dict](do_stuff_fuzzer.dict): a [fuzzing dictionary file](http://libfuzzer.info#dictionaries) for `DoStuff()`. Optional, but may improve fuzzing in many cases. * [do_stuff_fuzzer.options](do_stuff_fuzzer.options): optional file with flags specific to fuzzing engines, e.g. to pass the dictionary file to libFuzzer. @@ -17,6 +16,7 @@ Imagine that these files reside in your project's repository: * accepts external fuzzing engine via `$LIB_FUZZING_ENGINE`, by default uses [standalone_fuzz_taget_runner.cpp](standalone_fuzz_taget_runner.cpp) * builds the fuzz target(s) and their corpus archive(s) * `make check` executes [do_stuff_fuzzer.cpp](do_stuff_fuzzer.cpp) on [`do_stuff_test_data/*`](do_stuff_test_data), thus ensures that the fuzz target is up to date and uses it as a regression test. +* [standalone_fuzz_taget_runner.cpp](standalone_fuzz_taget_runner.cpp): is a simple standalone runnner for fuzz targets. You may use it to execute a fuzz target on given files w/o having to link in libFuzzer or other fuzzing engine. ## Files in OSS-Fuzz repository * [oss-fuzz/projects/example](..)