]> granicus.if.org Git - llvm/commitdiff
[libFuzzer] better docs for coverage
authorKostya Serebryany <kcc@google.com>
Thu, 5 May 2016 18:07:09 +0000 (18:07 +0000)
committerKostya Serebryany <kcc@google.com>
Thu, 5 May 2016 18:07:09 +0000 (18:07 +0000)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@268656 91177308-0d34-0410-b5e6-96231b3b80d8

docs/LibFuzzer.rst

index 015b7ef87aeebecf007039187c42dbc578b5abf9..529a99df87b6457ecfff167c7a741a394f332eea 100644 (file)
@@ -598,12 +598,15 @@ You can get the coverage for your corpus like this:
 
 .. code-block:: console
 
-  ASAN_OPTIONS=coverage=1 ./fuzzer CORPUS_DIR -runs=0
+  ASAN_OPTIONS=coverage=1:html_cov_report=1 ./fuzzer CORPUS_DIR -runs=0
 
-This will run all the tests in the CORPUS_DIR but will not generate any new tests
-and dump covered PCs to disk before exiting.
-Then you can subtract the set of covered PCs from the set of all instrumented PCs in the binary,
-see SanitizerCoverage_ for details.
+This will run all tests in the CORPUS_DIR but will not perform any fuzzing.
+At the end of the process it will dump a single html file with coverage information.
+See SanitizerCoverage_ for details.
+
+You may also use other ways to visualize coverage,
+e.g. `llvm-cov <http://llvm.org/docs/CommandGuide/llvm-cov.html>`_, but those will require
+you to rebuild the code with different compiler flags. 
 
 User-supplied mutators
 ----------------------