[libfuzzer] First part of libfuzzer-chrome documentation.

[libfuzzer] First part of libfuzzer-chrome documentation.

I expect to add 2 more documents in the follow up:

- clusterfuzz-libfuzzer integration documentation (build bots, corpus, status links, reports)
- reference (fuzzer_test reference, fuzzer options, dictionaries, etc.)

BUG=539572
Committed: https://crrev.com/a6f8629d0c954a259cf43f593d4aca125e299897
Cr-Commit-Position: refs/heads/master@{#381847}

[aizatsky, 2016-03-16 21:23:20]

Description was changed from

==========
[libfuzzer] First part of libfuzzer-chrome documentation.

I expect to add 2 more documents in the follow up:

- clusterfuzz-libfuzzer integration documentation (build bots, corpus, status
links, reports)
- reference (fuzzer_test reference, fuzzer options, dictionaries, etc.)

BUG=539572
==========

to

==========
[libfuzzer] First part of libfuzzer-chrome documentation.

I expect to add 2 more documents in the follow up:

- clusterfuzz-libfuzzer integration documentation (build bots, corpus, status
links, reports)
- reference (fuzzer_test reference, fuzzer options, dictionaries, etc.)

BUG=539572
==========

[aizatsky, 2016-03-16 21:23:20]

aizatsky@chromium.org changed reviewers:
+ inferno@chromium.org, kcc@chromium.org, mmoroz@chromium.org,
ochang@chromium.org

[mmoroz, 2016-03-17 11:58:13]

Left some comments/suggestions.

LGTM if you are going to land this and add updates in a separate CL.

https://codereview.chromium.org/1809843002/diff/1/testing/libfuzzer/README.md
File testing/libfuzzer/README.md (right):

https://codereview.chromium.org/1809843002/diff/1/testing/libfuzzer/README.md...
testing/libfuzzer/README.md:5: This directory contains integration between
[LibFuzzer] and Chrome.
May be "documentation about integration" / "information about integration" ?
Current sentence looks strange for me, but I'm not good in English so may be
absolutely wrong :)

https://codereview.chromium.org/1809843002/diff/1/testing/libfuzzer/README.md...
testing/libfuzzer/README.md:7: engineers to uncover potential stability problems
earlier.
Let's say "security and stability"?

https://codereview.chromium.org/1809843002/diff/1/testing/libfuzzer/README.md...
testing/libfuzzer/README.md:15: Fuzzer tests are well-integrated with Chrome
build & distributed ClusterFuzz
May be "Chrome build system"?

https://codereview.chromium.org/1809843002/diff/1/testing/libfuzzer/efficient...
File testing/libfuzzer/efficient_fuzzer.md (right):

https://codereview.chromium.org/1809843002/diff/1/testing/libfuzzer/efficient...
testing/libfuzzer/efficient_fuzzer.md:3: This documents describes ways to
determine your fuzzer efficiency and ways
nit: s/documents/document

https://codereview.chromium.org/1809843002/diff/1/testing/libfuzzer/getting_s...
File testing/libfuzzer/getting_started.md (right):

https://codereview.chromium.org/1809843002/diff/1/testing/libfuzzer/getting_s...
testing/libfuzzer/getting_started.md:69: Build and run with ninja as usual:
May be "Build with ninja as usual and run"?

https://codereview.chromium.org/1809843002/diff/1/testing/libfuzzer/getting_s...
testing/libfuzzer/getting_started.md:99: The 'pulse' line will appear periodicly
to show the current status.
May be "pulse" -> "pulse..."

[inferno, 2016-03-17 16:49:37]

lgtm.

Max - I also want a section on common mistakes, things like timeout, leaks, and
how people can workaround/instructions to fix them first before fuzzing become
effective, etc.

https://codereview.chromium.org/1809843002/diff/1/testing/libfuzzer/README.md
File testing/libfuzzer/README.md (right):

https://codereview.chromium.org/1809843002/diff/1/testing/libfuzzer/README.md...
testing/libfuzzer/README.md:16: fuzzing system. Cover bug: [crub.com/539572].
typo crub->crbug

https://codereview.chromium.org/1809843002/diff/1/testing/libfuzzer/README.md...
testing/libfuzzer/README.md:29: [crub.com/539572]:
https://bugs.chromium.org/p/chromium/issues/detail?id=539572
typo crub->crbug

https://codereview.chromium.org/1809843002/diff/1/testing/libfuzzer/clusterfu...
File testing/libfuzzer/clusterfuzz.md (right):

https://codereview.chromium.org/1809843002/diff/1/testing/libfuzzer/clusterfu...
testing/libfuzzer/clusterfuzz.md:7: fuzzer status goes here.
Max, can you add this in your TODOs to finish it later.

https://codereview.chromium.org/1809843002/diff/1/testing/libfuzzer/efficient...
File testing/libfuzzer/efficient_fuzzer.md (right):

https://codereview.chromium.org/1809843002/diff/1/testing/libfuzzer/efficient...
testing/libfuzzer/efficient_fuzzer.md:38: initialization and shared resources
rather than brining environment up and down
typo brining

https://codereview.chromium.org/1809843002/diff/1/testing/libfuzzer/getting_s...
File testing/libfuzzer/getting_started.md (right):

https://codereview.chromium.org/1809843002/diff/1/testing/libfuzzer/getting_s...
testing/libfuzzer/getting_started.md:10: * creating your first fuzzer
nit: end lines 9 and 10 with period like line 11.

[inferno, 2016-03-17 16:50:26]

just a fyi, my last point was asking Max to add the common mistakes section
later. this cl can go in with the nit fixes in comments.

[aizatsky, 2016-03-17 23:39:25]

all done. submitting.

https://codereview.chromium.org/1809843002/diff/1/testing/libfuzzer/README.md
File testing/libfuzzer/README.md (right):

https://codereview.chromium.org/1809843002/diff/1/testing/libfuzzer/README.md...
testing/libfuzzer/README.md:5: This directory contains integration between
[LibFuzzer] and Chrome.
On 2016/03/17 11:58:13, mmoroz wrote:
> May be "documentation about integration" / "information about integration" ?
> Current sentence looks strange for me, but I'm not good in English so may be
> absolutely wrong :)

No, in this case - the directory actually contains integration files (definition
etc.)

https://codereview.chromium.org/1809843002/diff/1/testing/libfuzzer/README.md...
testing/libfuzzer/README.md:7: engineers to uncover potential stability problems
earlier.
On 2016/03/17 11:58:13, mmoroz wrote:
> Let's say "security and stability"?

Done.

https://codereview.chromium.org/1809843002/diff/1/testing/libfuzzer/README.md...
testing/libfuzzer/README.md:15: Fuzzer tests are well-integrated with Chrome
build & distributed ClusterFuzz
On 2016/03/17 11:58:13, mmoroz wrote:
> May be "Chrome build system"?

Done.

https://codereview.chromium.org/1809843002/diff/1/testing/libfuzzer/README.md...
testing/libfuzzer/README.md:16: fuzzing system. Cover bug: [crub.com/539572].
On 2016/03/17 16:49:36, inferno wrote:
> typo crub->crbug

Done.

https://codereview.chromium.org/1809843002/diff/1/testing/libfuzzer/README.md...
testing/libfuzzer/README.md:29: [crub.com/539572]:
https://bugs.chromium.org/p/chromium/issues/detail?id=539572
On 2016/03/17 16:49:36, inferno wrote:
> typo crub->crbug

Done.

https://codereview.chromium.org/1809843002/diff/1/testing/libfuzzer/clusterfu...
File testing/libfuzzer/clusterfuzz.md (right):

https://codereview.chromium.org/1809843002/diff/1/testing/libfuzzer/clusterfu...
testing/libfuzzer/clusterfuzz.md:7: fuzzer status goes here.
On 2016/03/17 16:49:36, inferno wrote:
> Max, can you add this in your TODOs to finish it later.

I'll transfer the info from our site first. We'll be able to extend it later.

https://codereview.chromium.org/1809843002/diff/1/testing/libfuzzer/efficient...
File testing/libfuzzer/efficient_fuzzer.md (right):

https://codereview.chromium.org/1809843002/diff/1/testing/libfuzzer/efficient...
testing/libfuzzer/efficient_fuzzer.md:3: This documents describes ways to
determine your fuzzer efficiency and ways
On 2016/03/17 11:58:13, mmoroz wrote:
> nit: s/documents/document

Done.

https://codereview.chromium.org/1809843002/diff/1/testing/libfuzzer/efficient...
testing/libfuzzer/efficient_fuzzer.md:38: initialization and shared resources
rather than brining environment up and down
On 2016/03/17 16:49:36, inferno wrote:
> typo brining

Done.

https://codereview.chromium.org/1809843002/diff/1/testing/libfuzzer/getting_s...
File testing/libfuzzer/getting_started.md (right):

https://codereview.chromium.org/1809843002/diff/1/testing/libfuzzer/getting_s...
testing/libfuzzer/getting_started.md:10: * creating your first fuzzer
On 2016/03/17 16:49:37, inferno wrote:
> nit: end lines 9 and 10 with period like line 11.

Done.

https://codereview.chromium.org/1809843002/diff/1/testing/libfuzzer/getting_s...
testing/libfuzzer/getting_started.md:69: Build and run with ninja as usual:
On 2016/03/17 11:58:13, mmoroz wrote:
> May be "Build with ninja as usual and run"?

Done.

https://codereview.chromium.org/1809843002/diff/1/testing/libfuzzer/getting_s...
testing/libfuzzer/getting_started.md:99: The 'pulse' line will appear periodicly
to show the current status.
On 2016/03/17 11:58:13, mmoroz wrote:
> May be "pulse" -> "pulse..."

Done.

[aizatsky, 2016-03-17 23:39:29]

The CQ bit was checked by aizatsky@chromium.org

[aizatsky, 2016-03-17 23:39:30]

The patchset sent to the CQ was uploaded after l-g-t-m from
inferno@chromium.org, mmoroz@chromium.org
Link to the patchset: https://codereview.chromium.org/1809843002/#ps20001
(title: "review")

[commit-bot: I haz the power, 2016-03-17 23:40:14]

CQ is trying da patch. Follow status at
 https://chromium-cq-status.appspot.com/patch-status/1809843002/20001
View timeline at
 https://chromium-cq-status.appspot.com/patch-timeline/1809843002/20001

[commit-bot: I haz the power, 2016-03-18 00:22:32]

Description was changed from

==========
[libfuzzer] First part of libfuzzer-chrome documentation.

I expect to add 2 more documents in the follow up:

- clusterfuzz-libfuzzer integration documentation (build bots, corpus, status
links, reports)
- reference (fuzzer_test reference, fuzzer options, dictionaries, etc.)

BUG=539572
==========

to

==========
[libfuzzer] First part of libfuzzer-chrome documentation.

I expect to add 2 more documents in the follow up:

- clusterfuzz-libfuzzer integration documentation (build bots, corpus, status
links, reports)
- reference (fuzzer_test reference, fuzzer options, dictionaries, etc.)

BUG=539572
==========

[commit-bot: I haz the power, 2016-03-18 00:22:33]

Committed patchset #2 (id:20001)

[commit-bot: I haz the power, 2016-03-18 00:24:44]

Description was changed from

==========
[libfuzzer] First part of libfuzzer-chrome documentation.

I expect to add 2 more documents in the follow up:

- clusterfuzz-libfuzzer integration documentation (build bots, corpus, status
links, reports)
- reference (fuzzer_test reference, fuzzer options, dictionaries, etc.)

BUG=539572
==========

to

==========
[libfuzzer] First part of libfuzzer-chrome documentation.

I expect to add 2 more documents in the follow up:

- clusterfuzz-libfuzzer integration documentation (build bots, corpus, status
links, reports)
- reference (fuzzer_test reference, fuzzer options, dictionaries, etc.)

BUG=539572

Committed: https://crrev.com/a6f8629d0c954a259cf43f593d4aca125e299897
Cr-Commit-Position: refs/heads/master@{#381847}
==========

[commit-bot: I haz the power, 2016-03-18 00:24:45]

Patchset 2 (id:??) landed as
https://crrev.com/a6f8629d0c954a259cf43f593d4aca125e299897
Cr-Commit-Position: refs/heads/master@{#381847}

[aizatsky, 2016-03-18 00:26:28]

Some links are broken (works differently than local previewer), but here's how
it looks:

https://chromium.googlesource.com/chromium/src/+/master/testing/libfuzzer/

https://chromium.googlesource.com/chromium/src/+/master/testing/libfuzzer/get...

https://chromium.googlesource.com/chromium/src/+/master/testing/libfuzzer/eff...