Skip to content

Commit b9fb2ae

Browse files
committed
[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
1 parent 1bcd1b0 commit b9fb2ae

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

llvm/docs/FuzzingLLVM.rst

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ Introduction
1010
============
1111

1212
The LLVM tree includes a number of fuzzers for various components. These are
13-
built on top of :doc:`LibFuzzer <LibFuzzer>`.
13+
built on top of :doc:`LibFuzzer <LibFuzzer>`. In order to build and run these
14+
fuzzers, see :ref:`building-fuzzers`.
1415

1516

1617
Available Fuzzers
@@ -109,7 +110,8 @@ It receives optimzation pipeline and runs it for each fuzzer input.
109110

110111
Interface of this fuzzer almost directly mirrors ``llvm-isel-fuzzer``. Both
111112
``mtriple`` and ``passes`` arguments are required. Passes are specified in a
112-
format suitable for the new pass manager.
113+
format suitable for the new pass manager. You can find some documentation about
114+
this format in the doxygen for ``PassBuilder::parsePassPipeline``.
113115

114116
.. code-block:: shell
115117
@@ -236,6 +238,10 @@ by adding the following two flags to your CMake invocation:
236238
with sanitizers, you'll want to specify ``-DLLVM_BUILD_RUNTIME=Off``
237239
to avoid building the sanitizers themselves with sanitizers enabled.
238240

241+
.. note:: You may run into issues if you build with BFD ld, which is the
242+
default linker on many unix systems. These issues are being tracked
243+
in https://llvm.org/PR34636.
244+
239245
Continuously Running and Finding Bugs
240246
-------------------------------------
241247

0 commit comments

Comments
 (0)