Skip to content

Commit 567d27d

Browse files
committed
docs: update a usage chapter
The Lua mutator has been removed in commit 45231c6 ("mutator: get rid of custom libFuzzer mutator"). The patch drops an excess description for it.
1 parent 370b41a commit 567d27d

File tree

1 file changed

+0
-24
lines changed

1 file changed

+0
-24
lines changed

docs/usage.md

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -110,30 +110,6 @@ Run fuzzing target:
110110
$ lua examples/example_zlib.lua
111111
```
112112

113-
### Using custom mutators written in Lua
114-
115-
`luzer` allows [custom mutators][libfuzzer-mutators-url] to be written in Lua 5.1
116-
(including LuaJIT), 5.2, 5.3 or 5.4.
117-
118-
The environment variable `LIBFUZZER_LUA_SCRIPT` can be set to the path to the
119-
Lua mutator script. The default path is `./mutator.lua`.
120-
121-
To run the Lua example, use
122-
123-
```sh
124-
LIBFUZZER_LUA_SCRIPT=./mutator.lua example_compressed
125-
```
126-
127-
All you need to do on the C/C++ side is adding `mutator.c` or `crossover.c`
128-
file as a compilation unit.
129-
130-
Then write a Lua script that does what you would like the fuzzer to do, you
131-
might want to use the `mutator.lua` script. The environment variable
132-
`LIBFUZZER_LUA_SCRIPT` can be set to the path to the Lua mutator
133-
script. The default path is `./mutator.lua`. Then just run your fuzzing as
134-
shown in the examples above.
135-
136-
[libfuzzer-mutators-url]: https://github.com/google/fuzzing/blob/master/docs/structure-aware-fuzzing.md
137113
[ffi-library-url]: https://luajit.org/ext_ffi.html
138114
[programming-in-lua-8]: https://www.lua.org/pil/8.html
139115
[programming-in-lua-24]: https://www.lua.org/pil/24.html

0 commit comments

Comments
 (0)