Page MenuHomePhabricator

[libFuzzer] Improve documentation
ClosedPublic

Authored by daviddrysdale on Apr 27 2016, 5:27 AM.

Diff Detail

Event Timeline

daviddrysdale retitled this revision from to [libFuzzer] Improve documentation.
daviddrysdale updated this object.
daviddrysdale added a reviewer: kcc.
daviddrysdale added a subscriber: llvm-commits.
kcc edited edge metadata.Apr 27 2016, 9:51 AM

This is very cool, thanks!
I've made several minor comments.
The patch does not apply to ToT (arc patch D19585 says 2 out of 14 hunks FAILED), for some reason, you may need to svn up / merge.

docs/LibFuzzer.rst
2

For no particular reason I prefer libFuzzer.

96

via a specific fuzzing entrypoint (aka "target function");

97

s/generations/generates

107–108

I don't want to be this verbose.
Instead we should clearly state that the only supported variant (at least at this point) is trunk (or something very close to trunk).

307

(unless you disable this by `-reload=0` command line flag)

320

s/blocks/blocks or edges

330

Remove outer ()
Add something like "in this mode the fuzzer binary could be used as a regression test, i.e. on a continuous integration system"

377–380

why not svn?

629–630

While you are at it, remove this part (about function-scope statics).
It's not that bad in fact.

daviddrysdale edited edge metadata.

Markups from kcc initial pass. Merged up to later upstream version.

daviddrysdale marked 7 inline comments as done.
In D19585#413936, @kcc wrote:

This is very cool, thanks!
I've made several minor comments.
The patch does not apply to ToT (arc patch D19585 says 2 out of 14 hunks FAILED), for some reason, you may need to svn up / merge.

Sorry, forgot to merge up first. BTW, does Phabricator show whether the patch applies cleanly somewhere? I can't immediately see it in the UI.

docs/LibFuzzer.rst
2

OK, but how do you want to handle sentences that start with the name -- capitalize or not?

(At the moment I've left sentence starts as "LibFuzzer does xyz...")

377–381

When I tried it, the current SVN tip wouldn't build, so I thought it safer to stick with a fixed release -- less vulnerable that way.

kcc accepted this revision.Apr 28 2016, 8:24 AM
kcc edited edge metadata.

Thanks again, let me commit this.

This revision is now accepted and ready to land.Apr 28 2016, 8:24 AM
kcc closed this revision.Apr 28 2016, 8:24 AM