diff options
author | Max Moroz <mmoroz@chromium.org> | 2019-08-21 15:10:15 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-08-21 15:10:15 -0700 |
commit | 1b54658a285436658bf45c07148f61b926b1e39b (patch) | |
tree | 547ef3aa08e399ad35c117c20c8c840fe3716c96 /docs | |
parent | 9e4853525f5f82f0d812e35c53f86800976bf953 (diff) | |
download | oss-fuzz-1b54658a285436658bf45c07148f61b926b1e39b.tar.gz |
[docs] Replace "furthur" with "further" throughout the documentation. (#2737)
Diffstat (limited to 'docs')
-rw-r--r-- | docs/advanced-topics/corpora.md | 2 | ||||
-rw-r--r-- | docs/advanced-topics/ideal_integration.md | 6 | ||||
-rw-r--r-- | docs/faq.md | 4 | ||||
-rw-r--r-- | docs/further-reading/clusterfuzz.md (renamed from docs/furthur-reading/clusterfuzz.md) | 4 | ||||
-rw-r--r-- | docs/further-reading/further_reading.md | 9 | ||||
-rw-r--r-- | docs/further-reading/fuzzer_environment.md (renamed from docs/furthur-reading/fuzzer_environment.md) | 4 | ||||
-rw-r--r-- | docs/furthur-reading/furthur_reading.md | 9 | ||||
-rw-r--r-- | docs/getting-started/accepting_new_projects.md | 2 | ||||
-rw-r--r-- | docs/getting-started/new_project_guide.md | 7 | ||||
-rw-r--r-- | docs/oss-fuzz/architecture.md | 4 | ||||
-rw-r--r-- | docs/reference/glossary.md | 2 |
11 files changed, 27 insertions, 26 deletions
diff --git a/docs/advanced-topics/corpora.md b/docs/advanced-topics/corpora.md index dd4ccc7fd..db3e5fabc 100644 --- a/docs/advanced-topics/corpora.md +++ b/docs/advanced-topics/corpora.md @@ -34,7 +34,7 @@ listed in your project's `project.yaml` file. ## Viewing the corpus for a fuzz target The fuzzer statistics page for your project on -[ClusterFuzz]({{ site.baseurl }}/furthur-reading/clusterfuzz) +[ClusterFuzz]({{ site.baseurl }}/further-reading/clusterfuzz) will contain a link to the Google Cloud console for your corpus under the "corpus_size" column. You can browse and download individual test inputs in the corpus here. diff --git a/docs/advanced-topics/ideal_integration.md b/docs/advanced-topics/ideal_integration.md index e0926a10e..b8447e091 100644 --- a/docs/advanced-topics/ideal_integration.md +++ b/docs/advanced-topics/ideal_integration.md @@ -115,9 +115,9 @@ The syntax is described [here](http://libfuzzer.info/#dictionaries). ## Coverage For a fuzz target to be useful, it must have good coverage in the code that it is testing. You can view the coverage for your fuzz targets by looking at the -[fuzzer stats]({{ site.baseurl }}/furthur-reading/clusterfuzz#fuzzer-stats) +[fuzzer stats]({{ site.baseurl }}/further-reading/clusterfuzz#fuzzer-stats) dashboard on ClusterFuzz, as well as -[coverage reports]({{ site.baseurl }}/furthur-reading/clusterfuzz#coverage-reports). +[coverage reports]({{ site.baseurl }}/further-reading/clusterfuzz#coverage-reports). To generate an aggregated code coverage report for your project, please see [code coverage]({{ site.baseurl }}/advanced-topics/code-coverage) @@ -142,7 +142,7 @@ Examples: [SQLite](https://www.sqlite.org/src/artifact/d9f1a6f43e7bab45), Fuzz targets should also be performant, as high memory usage and/or slow execution speed can slow the down the growth of coverage and finding of new bugs. ClusterFuzz provides a -[performance analyzer]({{ site.baseurl }}/furthur-reading/clusterfuzz/#performance-analyzer) +[performance analyzer]({{ site.baseurl }}/further-reading/clusterfuzz/#performance-analyzer) for each fuzz target that shows problems that are impacting the performance of the fuzz target. diff --git a/docs/faq.md b/docs/faq.md index b585f3fc4..872cb77bf 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -56,7 +56,7 @@ We will reconsider the GitHub issue tracker once the ## Why do you require a Google account for authentication? -Our [ClusterFuzz]({{ site.baseurl }}/furthur-reading/clusterfuzz) fuzzing +Our [ClusterFuzz]({{ site.baseurl }}/further-reading/clusterfuzz) fuzzing infrastructure and [issue tracker](https://bugs.chromium.org/p/oss-fuzz/issues/list) require a Google account for authentication. Note that an alternate email address associated with a Google account does not work due to appengine api @@ -134,7 +134,7 @@ coverage, it may mean several things: (you may check the speed of your targets at https://oss-fuzz.com/) In either case, look at the -[coverage reports]({{ site.baseurl }}/furthur-reading/clusterfuzz#coverage-reports) +[coverage reports]({{ site.baseurl }}/further-reading/clusterfuzz#coverage-reports) for your target(s) and figure out why some parts of the code are not covered. ## Why are code coverage reports public? diff --git a/docs/furthur-reading/clusterfuzz.md b/docs/further-reading/clusterfuzz.md index d37e256d2..92d85ff4c 100644 --- a/docs/furthur-reading/clusterfuzz.md +++ b/docs/further-reading/clusterfuzz.md @@ -1,9 +1,9 @@ --- layout: default title: ClusterFuzz -parent: Furthur reading +parent: Further reading nav_order: 1 -permalink: /furthur-reading/clusterfuzz/ +permalink: /further-reading/clusterfuzz/ --- # ClusterFuzz diff --git a/docs/further-reading/further_reading.md b/docs/further-reading/further_reading.md new file mode 100644 index 000000000..1b12bf43f --- /dev/null +++ b/docs/further-reading/further_reading.md @@ -0,0 +1,9 @@ +--- +layout: default +title: Further reading +has_children: true +nav_order: 4 +permalink: /further-reading/ +--- + +# Further reading diff --git a/docs/furthur-reading/fuzzer_environment.md b/docs/further-reading/fuzzer_environment.md index b8138c343..64b16c7ff 100644 --- a/docs/furthur-reading/fuzzer_environment.md +++ b/docs/further-reading/fuzzer_environment.md @@ -1,9 +1,9 @@ --- layout: default title: Fuzzer environment -parent: Furthur reading +parent: Further reading nav_order: 2 -permalink: /furthur-reading/fuzzer-environment/ +permalink: /further-reading/fuzzer-environment/ --- # Fuzzer environment on ClusterFuzz diff --git a/docs/furthur-reading/furthur_reading.md b/docs/furthur-reading/furthur_reading.md deleted file mode 100644 index 471e5e7c9..000000000 --- a/docs/furthur-reading/furthur_reading.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -layout: default -title: Furthur reading -has_children: true -nav_order: 4 -permalink: /furthur-reading/ ---- - -# Furthur reading diff --git a/docs/getting-started/accepting_new_projects.md b/docs/getting-started/accepting_new_projects.md index f8236393a..b0ae1f989 100644 --- a/docs/getting-started/accepting_new_projects.md +++ b/docs/getting-started/accepting_new_projects.md @@ -28,7 +28,7 @@ with a new `projects/<project_name>/project.yaml` file ([why?]({{ site.baseurl }}/faq/#why-do-you-require-a-google-account-for-authentication)). If you use an alternate email address [linked to a Google Account](https://support.google.com/accounts/answer/176347?hl=en), - you'll only get access to [filed bugs in the issue tracker](https://bugs.chromium.org/p/oss-fuzz/issues/list), not to the [ClusterFuzz]({{ site.baseurl }}/furthur-reading/clusterfuzz) + you'll only get access to [filed bugs in the issue tracker](https://bugs.chromium.org/p/oss-fuzz/issues/list), not to the [ClusterFuzz]({{ site.baseurl }}/further-reading/clusterfuzz) dashboard. This is due to appengine API limitations. 3. Once your project is accepted, configure it by following the [New Project Guide]({{ site.baseurl }}/getting-started/new-project-guide/). diff --git a/docs/getting-started/new_project_guide.md b/docs/getting-started/new_project_guide.md index 0c548a062..5059ac0d4 100644 --- a/docs/getting-started/new_project_guide.md +++ b/docs/getting-started/new_project_guide.md @@ -19,6 +19,7 @@ Before you can start setting up your new project for fuzzing, you must do the fo - [Integrate]({{ site.baseurl }}/advanced-topics/ideal-integration/) one or more [fuzz targets]({{ site.baseurl }}/reference/glossary/#fuzz-target) with the project you want to fuzz. + For examples, see [boringssl](https://github.com/google/boringssl/tree/master/fuzz), [SQLite](https://www.sqlite.org/src/artifact/ad79e867fb504338), @@ -124,7 +125,7 @@ sanitizers: ``` Crashes can be accessed on the [ClusterFuzz -homepage]({{ site.baseurl }}/furthur-reading/clusterfuzz#web-interface). +homepage]({{ site.baseurl }}/further-reading/clusterfuzz#web-interface). `sanitizers` example: [boringssl](https://github.com/google/oss-fuzz/blob/master/projects/boringssl/project.yaml). @@ -255,7 +256,7 @@ In addition, please keep the size of the build (everything copied to `$OUT`) sma ## Fuzzer execution environment For more on the environment that -your [fuzz targets]({{ site.baseurl }}/reference/glossary/#fuzz-target) run in, and the assumptions you can make, see the [fuzzer environment]({{ site.baseurl }}/furthur-reading/fuzzer-environment/) page. +your [fuzz targets]({{ site.baseurl }}/reference/glossary/#fuzz-target) run in, and the assumptions you can make, see the [fuzzer environment]({{ site.baseurl }}/further-reading/fuzzer-environment/) page. ## Testing locally @@ -303,7 +304,7 @@ that all system dependencies are of the supported build configurations with the above commands (build_fuzzers -> run_fuzzer -> coverage).</b> If everything works locally, it should also work on our automated builders and ClusterFuzz. If you check in -your files and experience failures, review your [dependencies]({{ site.baseurl }}/furthur-reading/fuzzer-environment/#dependencies). +your files and experience failures, review your [dependencies]({{ site.baseurl }}/further-reading/fuzzer-environment/#dependencies). ## Debugging Problems diff --git a/docs/oss-fuzz/architecture.md b/docs/oss-fuzz/architecture.md index 79539bc75..689870eaa 100644 --- a/docs/oss-fuzz/architecture.md +++ b/docs/oss-fuzz/architecture.md @@ -18,7 +18,7 @@ with the project's build and test system. 1. The project is [accepted to OSS-Fuzz]({{ site.baseurl }}/getting-started/accepting-new-projects/) and the developer commits their build configurations. 1. The OSS-Fuzz [builder](jenkins.io) builds the project from the committed configs. 1. The builder uploads the fuzz targets to the OSS-Fuzz GCS bucket. -1. [ClusterFuzz]({{ site.baseurl }}/furthur-reading/clusterfuzz) downloads the fuzz targets and begins to fuzz the projects. +1. [ClusterFuzz]({{ site.baseurl }}/further-reading/clusterfuzz) downloads the fuzz targets and begins to fuzz the projects. 1. When Clusterfuzz finds a bug, it reports the issue automatically to the OSS-Fuzz [issue tracker](https://bugs.chromium.org/p/oss-fuzz/issues/list) @@ -28,6 +28,6 @@ with the project's build and test system. 1. The project developer fixes the bug upstream and credits OSS-Fuzz for the discovery (the commit message should contain the string **'Credit to OSS-Fuzz'**). -Once the developer fixes the bug, [ClusterFuzz]({{ site.baseurl }}/furthur-reading/clusterfuzz) automatically +Once the developer fixes the bug, [ClusterFuzz]({{ site.baseurl }}/further-reading/clusterfuzz) automatically verifies the fix, adds a comment, and closes the issue ([example](https://bugs.chromium.org/p/oss-fuzz/issues/detail?id=53#c3)). 30 days after the fix is verified or 90 days after reporting (whichever is earlier), the issue becomes [public]({{ site.baseurl }}/getting-started/bug-disclosure-guidelines/). diff --git a/docs/reference/glossary.md b/docs/reference/glossary.md index 01a26b688..374bd4254 100644 --- a/docs/reference/glossary.md +++ b/docs/reference/glossary.md @@ -25,7 +25,7 @@ A scalable fuzzing infrastructure that is used for OSS-Fuzz backend. [ClusterFuzz] is also used to fuzz Chrome and many other projects. A quick overview of ClusterFuzz user interface is available on this [page]. -[page]: {{ site.baseurl }}/furthur-reading/clusterfuzz +[page]: {{ site.baseurl }}/further-reading/clusterfuzz [ClusterFuzz]: https://github.com/google/clusterfuzz ### Fuzz Target |