From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Mon, 16 Sep 2024 20:29:02 +0000 (+0200)
Subject: [3.12] gh-121023: Improve `_xxtestfuzz/README.rst` (GH-121024) (#124141)
X-Git-Tag: v3.12.7~88
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=446203e122136a65cf40634eda78b5f0a8c1f05c;p=thirdparty%2FPython%2Fcpython.git

[3.12] gh-121023: Improve `_xxtestfuzz/README.rst` (GH-121024) (#124141)

gh-121023: Improve `_xxtestfuzz/README.rst` (GH-121024)
(cherry picked from commit a9c2bc16349c2be3005f97249f3ae9699988f218)

Co-authored-by: sobolevn <mail@sobolevn.me>
Co-authored-by: Illia Volochii <illia.volochii@gmail.com>
---

diff --git a/Modules/_xxtestfuzz/README.rst b/Modules/_xxtestfuzz/README.rst
index 42bd02a03cbe..27c44f7bb8e5 100644
--- a/Modules/_xxtestfuzz/README.rst
+++ b/Modules/_xxtestfuzz/README.rst
@@ -20,7 +20,7 @@ Add the test name on a new line in ``fuzz_tests.txt``.
 
 In ``fuzzer.c``, add a function to be run::
 
-    int $test_name (const char* data, size_t size) {
+    static int $fuzz_test_name(const char* data, size_t size) {
         ...
         return 0;
     }
@@ -28,10 +28,12 @@ In ``fuzzer.c``, add a function to be run::
 
 And invoke it from ``LLVMFuzzerTestOneInput``::
 
-    #if _Py_FUZZ_YES(fuzz_builtin_float)
-        rv |= _run_fuzz(data, size, fuzz_builtin_float);
+    #if !defined(_Py_FUZZ_ONE) || defined(_Py_FUZZ_$fuzz_test_name)
+        rv |= _run_fuzz(data, size, $fuzz_test_name);
     #endif
 
+Don't forget to replace ``$fuzz_test_name`` with your actual test name.
+
 ``LLVMFuzzerTestOneInput`` will run in oss-fuzz, with each test in
 ``fuzz_tests.txt`` run separately.