diff options
| author | Stefan Bucur <281483+stefanbucur@users.noreply.github.com> | 2021-03-25 10:43:18 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-03-25 07:43:18 -0700 |
| commit | 589afcfbd1daafd96dfa178bfc3c3656bc6df81d (patch) | |
| tree | b19223138106deea5fbbae2e4148a71577fbab81 | |
| parent | 84178cd28f8c8b6dbc1a4c2b389228f78fe25dd0 (diff) | |
| download | oss-fuzz-589afcfbd1daafd96dfa178bfc3c3656bc6df81d.tar.gz | |
Clarify in the new project guide that pull_images may be needed for coverage runs. (#5506)
| -rw-r--r-- | docs/faq.md | 13 | ||||
| -rw-r--r-- | docs/getting-started/new_project_guide.md | 3 |
2 files changed, 15 insertions, 1 deletions
diff --git a/docs/faq.md b/docs/faq.md index fa0826c48..46e5ebf80 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -158,6 +158,19 @@ We work with open source projects and try to keep as much information public as possible. We believe that public code coverage reports do not put users at risk, as they do not indicate the presence of bugs or lack thereof. +## Why is the coverage command complaining about format compatibility issues? + +This may happen if the Docker images fetched locally become out of sync. Make +sure you run the following command to pull the most recent images: + +```bash +$ python infra/helper.py pull_images +``` + +Please refer to +[code coverage]({{ site.baseurl }}/advanced-topics/code-coverage/) for detailed +information on code coverage generation. + ## What happens when I rename a fuzz target ? If you rename your fuzz targets, the existing bugs for those targets will get diff --git a/docs/getting-started/new_project_guide.md b/docs/getting-started/new_project_guide.md index 0ffba8f96..d2a7d805b 100644 --- a/docs/getting-started/new_project_guide.md +++ b/docs/getting-started/new_project_guide.md @@ -359,7 +359,8 @@ generated from the previous `run_fuzzer` step in your local corpus directory. $ python infra/helper.py coverage $PROJECT_NAME --fuzz-target=<fuzz_target> --corpus-dir=<path-to-temp-corpus-dir> ``` -Please refer to +You may need to run `python infra/helper.py pull_images` to use the latest +coverage tools. Please refer to [code coverage]({{ site.baseurl }}/advanced-topics/code-coverage/) for detailed information on code coverage generation. |