diff options
author | Kostya Serebryany <kcc@google.com> | 2017-08-11 20:32:47 +0000 |
---|---|---|
committer | Kostya Serebryany <kcc@google.com> | 2017-08-11 20:32:47 +0000 |
commit | 0a4c4a2bdd646c9227ca4751f8592d923c876553 (patch) | |
tree | cf232a6afbd9ddc19118db312a9c572a72d1c663 /docs/LibFuzzer.rst | |
parent | 65b6f2d17462e3d58c5b3b325f25c9bb375e8e08 (diff) |
[libFuzzer] recommend Clang Coverage for coverage visualization
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@310751 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/LibFuzzer.rst')
-rw-r--r-- | docs/LibFuzzer.rst | 28 |
1 files changed, 4 insertions, 24 deletions
diff --git a/docs/LibFuzzer.rst b/docs/LibFuzzer.rst index d9c7966a721..7e01c7e1b18 100644 --- a/docs/LibFuzzer.rst +++ b/docs/LibFuzzer.rst @@ -317,10 +317,6 @@ The most important command line options are: - 1 : close ``stdout`` - 2 : close ``stderr`` - 3 : close both ``stdout`` and ``stderr``. -``-print_coverage`` - If 1, print coverage information as text at exit. -``-dump_coverage`` - 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 ---------------------- |