]> granicus.if.org Git - llvm/commitdiff
docs: Improve the docs about llvm-isel-fuzzer on OSS Fuzz
authorJustin Bogner <mail@justinbogner.com>
Fri, 13 Oct 2017 00:27:35 +0000 (00:27 +0000)
committerJustin Bogner <mail@justinbogner.com>
Fri, 13 Oct 2017 00:27:35 +0000 (00:27 +0000)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@315651 91177308-0d34-0410-b5e6-96231b3b80d8

docs/FuzzingLLVM.rst

index aa777cf7cd6685b9951bd2cce16c5e590f654e88..138c655a962e20fabdae94182ca4bc8a7206d494 100644 (file)
@@ -83,10 +83,15 @@ the following command would fuzz AArch64 with :doc:`GlobalISel`:
 
 Some flags can also be specified in the binary name itself in order to support
 OSS Fuzz, which has trouble with required arguments. To do this, you can copy
-or move ``llvm-isel-fuzzer`` to ``llvm-isel-fuzzer--x-y-z``, where x, y, and z
-are architecture names (``aarch64``, ``x86_64``), optimization levels (``O0``,
-``O2``), or specific keywords like ``gisel`` for enabling global instruction
-selection.
+or move ``llvm-isel-fuzzer`` to ``llvm-isel-fuzzer--x-y-z``, separating options
+from the binary name using "--". The valid options are architecture names
+(``aarch64``, ``x86_64``), optimization levels (``O0``, ``O2``), or specific
+keywords, like ``gisel`` for enabling global instruction selection. In this
+mode, the same example could be run like so:
+
+.. code-block:: shell
+
+   % bin/llvm-isel-fuzzer--aarch64-O0-gisel <corpus-dir>
 
 llvm-mc-assemble-fuzzer
 -----------------------