search

MozillaSecurity / funfuzz

A collection of fuzzers in a harness for testing the SpiderMonkey JavaScript engine.
Mozilla Public License 2.0
630 stars 115 forks source link

Documentation for compileShell #5

Closed nth10sd closed 9 years ago

nth10sd commented 9 years ago

We need some basic documentation in the README.md for using compileShell.

nth10sd commented 9 years ago

I've added more documentation in rev b105f09.

jruderman commented 9 years ago

I'd prefer for this to be separate from js/README.md, so it's not in the way of people looking for information about the fuzzer. Can you move this new documentation to somewhere like js/compileShell.md? We can change the sentence starting with "To test an existing SpiderMonkey shell..." to link to the compileShell documentation.

The "examples" section seems excessive.

nth10sd commented 9 years ago

There seems to be lots of files in this directory we can write docs for. compileShell, jsfunfuzz, compareJIT, shellFlags, ... However, there is js/jsfunfuzz/ directory that we can move the "What jsfunfuzz does" to. (and link to them from README.md here) Should we elaborate more on jsfunfuzz in the future, it seems like it might be a better place there.

I can move examples into examples-compileShell.md. I think the more examples there are, the better, though I agree it may be too verbose for README.md. The FAQ can also be moved to, if needed. (maybe to faq-compileShell.md?)

Thoughts?

nth10sd commented 9 years ago

Moved FAQ section in rev 2b50d42.