[3.13] gh-121023: Improve _xxtestfuzz/README.rst (GH-121024) (#124140)

miss-islington · sobolevn · illia-v · web-flow · commit 9d21c46e3118 · 2024-09-23T17:23:54.000-07:00
gh-121023: Improve `_xxtestfuzz/README.rst` (GH-121024) (cherry picked from commit a9c2bc1) 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
@@ -23,18 +23,20 @@ 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;
     }
 
 
 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.
 
