[llvm] r310751 - [libFuzzer] recommend Clang Coverage for coverage visualization

Kostya Serebryany via llvm-commits llvm-commits at lists.llvm.org
Fri Aug 11 13:32:47 PDT 2017

Author: kcc
Date: Fri Aug 11 13:32:47 2017
New Revision: 310751

URL: http://llvm.org/viewvc/llvm-project?rev=310751&view=rev
[libFuzzer] recommend Clang Coverage for coverage visualization


Modified: llvm/trunk/docs/LibFuzzer.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/LibFuzzer.rst?rev=310751&r1=310750&r2=310751&view=diff
--- llvm/trunk/docs/LibFuzzer.rst (original)
+++ llvm/trunk/docs/LibFuzzer.rst Fri Aug 11 13:32:47 2017
@@ -317,10 +317,6 @@ The most important command line options
    - 1 : close ``stdout``
    - 2 : close ``stderr``
    - 3 : close both ``stdout`` and ``stderr``.
-   If 1, print coverage information as text at exit.
-   If 1, dump coverage information as a .sancov file at exit.
 For the full list of flags run the fuzzer binary with ``-help=1``.
@@ -558,28 +554,12 @@ How good is my fuzzer?
 Once you implement your target function ``LLVMFuzzerTestOneInput`` and fuzz it to death,
 you will want to know whether the function or the corpus can be improved further.
 One easy to use metric is, of course, code coverage.
-You can get the coverage for your corpus like this:
-.. code-block:: console
-  ./fuzzer CORPUS_DIR -runs=0 -print_coverage=1
-This will run all tests in the CORPUS_DIR but will not perform any fuzzing.
-At the end of the process it will print text describing what code has been covered and what hasn't.
-Alternatively, use
-.. code-block:: console
-  ./fuzzer CORPUS_DIR -runs=0 -dump_coverage=1
-which will dump a ``.sancov`` file with coverage information.
-See SanitizerCoverage_ for details on querying the file using the ``sancov`` tool.
+We recommend to use
+`Clang Coverage <http://clang.llvm.org/docs/SourceBasedCodeCoverage.html>`_,
+to visualize and study your code coverage
+(`example <https://github.com/google/fuzzer-test-suite/blob/master/tutorial/libFuzzerTutorial.md#visualizing-coverage>`_).
-You may also use other ways to visualize coverage,
-e.g. using `Clang coverage <http://clang.llvm.org/docs/SourceBasedCodeCoverage.html>`_,
-but those will require
-you to rebuild the code with different compiler flags.
 User-supplied mutators

More information about the llvm-commits mailing list