From 5605a0b70a6ff366823a5e626167d3c0677059b3 Mon Sep 17 00:00:00 2001 From: Justin Bogner Date: Thu, 16 Aug 2018 21:55:09 +0000 Subject: [PATCH] [docs] Try to clarify the FuzzingLLVM docs Try to improve these docs based on some recent questions that were sent to llvm-dev: http://lists.llvm.org/pipermail/llvm-dev/2018-August/125329.html llvm-svn: 339949 --- docs/FuzzingLLVM.rst | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/FuzzingLLVM.rst b/docs/FuzzingLLVM.rst index b3cf719f275..825e6d7ae02 100644 --- a/docs/FuzzingLLVM.rst +++ b/docs/FuzzingLLVM.rst @@ -10,7 +10,8 @@ Introduction ============ The LLVM tree includes a number of fuzzers for various components. These are -built on top of :doc:`LibFuzzer `. +built on top of :doc:`LibFuzzer `. In order to build and run these +fuzzers, see :ref:`building-fuzzers`. Available Fuzzers @@ -109,7 +110,8 @@ It receives optimzation pipeline and runs it for each fuzzer input. Interface of this fuzzer almost directly mirrors ``llvm-isel-fuzzer``. Both ``mtriple`` and ``passes`` arguments are required. Passes are specified in a -format suitable for the new pass manager. +format suitable for the new pass manager. You can find some documentation about +this format in the doxygen for ``PassBuilder::parsePassPipeline``. .. code-block:: shell @@ -236,6 +238,10 @@ by adding the following two flags to your CMake invocation: with sanitizers, you'll want to specify ``-DLLVM_BUILD_RUNTIME=Off`` to avoid building the sanitizers themselves with sanitizers enabled. +.. note:: You may run into issues if you build with BFD ld, which is the + default linker on many unix systems. These issues are being tracked + in https://llvm.org/PR34636. + Continuously Running and Finding Bugs -------------------------------------