diff options
| author | Zhicheng Cai <16498538+zchcai@users.noreply.github.com> | 2020-05-15 21:22:28 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-05-15 19:22:28 -0700 |
| commit | 6b9b08eb601c69a3c67366e0fe0c31b54f7427d5 (patch) | |
| tree | 1725779e89d001adad1feba909a18b01c52bd9e3 /docs/getting-started | |
| parent | 0e2df024ed6b3e16af9d1b4af469a8d6f6a84c58 (diff) | |
| download | oss-fuzz-6b9b08eb601c69a3c67366e0fe0c31b54f7427d5.tar.gz | |
[doc] Update new_project_guide.md (#3828)
Diffstat (limited to 'docs/getting-started')
| -rw-r--r-- | docs/getting-started/new_project_guide.md | 10 |
1 files changed, 4 insertions, 6 deletions
diff --git a/docs/getting-started/new_project_guide.md b/docs/getting-started/new_project_guide.md index ea6b372a7..7ea668fdb 100644 --- a/docs/getting-started/new_project_guide.md +++ b/docs/getting-started/new_project_guide.md @@ -39,6 +39,9 @@ Before you can start setting up your new project for fuzzing, you must do the fo [docker-cleanup](https://gist.github.com/mikea/d23a839cba68778d94e0302e8a2c200f) periodically to garbage-collect unused images. +- (optional) [Install gsutil](https://cloud.google.com/storage/docs/gsutil_install) for local code coverage sanity check. + For Google internal (gLinux) machines, please refer [here](https://cloud.google.com/storage/docs/gsutil_install#deb) instead. + ## Creating the file structure Each OSS-Fuzz project has a subdirectory @@ -306,12 +309,7 @@ You can build your docker image and fuzz targets locally, so you can test them b ``` 4. We recommend taking a look at your code coverage as a sanity check to make sure that your -fuzz targets get to the code you expect: - - ```bash - $ python infra/helper.py build_fuzzers --sanitizer coverage $PROJECT_NAME - $ python infra/helper.py coverage $PROJECT_NAME <fuzz_target> - ``` +fuzz targets get to the code you expect. Please refer to [code coverage]({{ site.baseurl }}/advanced-topics/code-coverage/). **Note:** Currently, we only support AddressSanitizer (address) and UndefinedBehaviorSanitizer (undefined) configurations. MemorySanitizer is recommended, but needs to be enabled manually once you verify |