about summary refs log tree commit diff
path: root/docs/custom_mutators.md
diff options
context:
space:
mode:
authorvanhauser-thc <vh@thc.org>2023-06-08 08:42:23 +0200
committervanhauser-thc <vh@thc.org>2023-06-08 08:42:23 +0200
commite71d422b3c9867249dcaac87e40b08010fc43497 (patch)
treef561dc20ab8dfc5f8713a1b6970ff56719bfdade /docs/custom_mutators.md
parent88603a2c2e770b20373c4002cb4aaf4e7b058ae5 (diff)
downloadafl++-e71d422b3c9867249dcaac87e40b08010fc43497.tar.gz
enhance custom mutator docs
Diffstat (limited to 'docs/custom_mutators.md')
-rw-r--r--docs/custom_mutators.md15
1 files changed, 9 insertions, 6 deletions
diff --git a/docs/custom_mutators.md b/docs/custom_mutators.md
index 3f7e9e6e..c5a64622 100644
--- a/docs/custom_mutators.md
+++ b/docs/custom_mutators.md
@@ -145,12 +145,15 @@ def deinit():  # optional for Python
 
 - `fuzz` (optional):
 
-    This method performs custom mutations on a given input. It also accepts an
-    additional test case. Note that this function is optional - but it makes
-    sense to use it. You would only skip this if `post_process` is used to fix
-    checksums etc. so if you are using it, e.g., as a post processing library.
-    Note that a length > 0 *must* be returned!
-    The returned output buffer is under **your** memory management!
+    This method performs your custom mutations on a given input.
+    The add_buf is the contents of another queue item that can be used for
+    splicing - or anything else - and can also be ignored. If you are not
+    using this additional data then define `splice_optout` (see above).
+    This function is optional.
+    Returing a length of 0 is valid and is interpreted as skipping this
+    one mutation result.
+    For non-Python: the returned output buffer is under **your** memory
+    management!
 
 - `describe` (optional):