diff options
| author |  jonathanmetzman <31354670+jonathanmetzman@users.noreply.github.com> | 2018-05-02 09:46:31 -0700 |
|---|---|---|
| committer |  GitHub <noreply@github.com> | 2018-05-02 09:46:31 -0700 |
| commit | 2447f78cf0f791331b24f2b3b65d1eeaeb86c493 (patch) | |
| tree | b3ce08e96e2d645df37d1a0f14310aa49923de39 /docs/new_project_guide.md | |
| parent | e06ca92ee48d10a387c7c7821f08c5c306cb244a (diff) | |
Document help_url in new project guide (#1395)
* Document help_url.
Diffstat (limited to 'docs/new_project_guide.md')
| -rw-r--r-- | docs/new_project_guide.md | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/new_project_guide.md b/docs/new_project_guide.md index a7ce80f7..64060fea 100644 --- a/docs/new_project_guide.md +++ b/docs/new_project_guide.md @@ -54,10 +54,14 @@ which includes crash reports, fuzzer statistics, etc and are auto-cced on newly tracker. * `sanitizers` (optional) - List of sanitizers to use. By default, you shouldn't override this and it will use the default list of supported sanitizers (currently - -AddressSanitizer("address"), UndefinedBehaviorSanitizer("undefined")). +AddressSanitizer("address"), UndefinedBehaviorSanitizer("undefined")). If your project does not build with a particular sanitizer configuration and you need some time fixing it, then you can use this option to override the defaults temporarily. E.g. For disabling UndefinedBehaviourSanitizer build, then you can just specify all supported sanitizers, except "undefined". +* `help_url` (optional) - 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 +bugs to members of your project unfamiliar with OSS-Fuzz or if they should follow a different workflow for +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). |