mirror of https://github.com/google/oss-fuzz.git
Add experimental flag in new project guide docs. (#1650)
* Update new_project_guide.md * Update new_project_guide.md
This commit is contained in:
parent
5e067e6f3d
commit
f3e21472aa
|
@ -71,6 +71,18 @@ For this to work, ensure that your project's runtime dependencies are listed in
|
|||
[this file](https://github.com/google/oss-fuzz/blob/master/infra/base-images/msan-builder/Dockerfile#L20).
|
||||
You may opt-in by adding "memory" to this list.
|
||||
|
||||
If you want to test a particular sanitizer (e.g. memory) and see what crashes it generates without filing
|
||||
them in the issue tracker, you can set the experimental flag. The crashes can be accessed on [ClusterFuzz
|
||||
homepage](clusterfuzz.md#web-interface). Example:
|
||||
|
||||
```
|
||||
sanitizers:
|
||||
- address
|
||||
- memory:
|
||||
experimental: True
|
||||
- undefined
|
||||
```
|
||||
|
||||
### help_url
|
||||
Link to a custom help URL in bug reports instead of the
|
||||
[default OSS-Fuzz guide to reproducing crashes](https://github.com/google/oss-fuzz/blob/master/docs/reproducing.md). This can be useful if you assign
|
||||
|
@ -79,6 +91,24 @@ reproducing and fixing bugs than standard one outlined in the reproducing guide.
|
|||
|
||||
Example: [boringssl](https://github.com/google/oss-fuzz/blob/master/projects/boringssl/project.yaml).
|
||||
|
||||
### experimental
|
||||
A boolean (either True or False) that indicates whether this project is in evaluation mode. This allows a project to be
|
||||
fuzzed and generate crash findings, but not file them in the issue tracker. The crashes can be accessed on [ClusterFuzz homepage](clusterfuzz.md#web-interface). This should be only used if you are not a maintainer of the project and have
|
||||
less confidence in the efficacy of your fuzz targets. Example:
|
||||
|
||||
```
|
||||
homepage: "{project_homepage}"
|
||||
primary_contact: "{primary_contact}"
|
||||
auto_ccs:
|
||||
- "{auto_cc_1}"
|
||||
- "{auto_cc_2}"
|
||||
sanitizers:
|
||||
- address
|
||||
- memory
|
||||
- undefined
|
||||
help_url: "{help_url}"
|
||||
experimental: True
|
||||
```
|
||||
## Dockerfile
|
||||
|
||||
This file defines the Docker image definition. This is where the build.sh script will be executed in.
|
||||
|
|
Loading…
Reference in New Issue