Skip to content

Improve _xxtestfuzz/README.rst #121023

Description

@sobolevn

Bug report

Right now there are several points I would like to see improved in this file:

  1. We need to clarify that $test_name should be replaced with an actual test name:
    int $test_name (const char* data, size_t size) {
    ...
    return 0;
    }
  2. _Py_FUZZ_YES is not actually used in our code, docs:
    #if _Py_FUZZ_YES(fuzz_builtin_float)
    code:
    #if !defined(_Py_FUZZ_ONE) || defined(_Py_FUZZ_fuzz_elementtree_parsewhole)
  3. Why is fuzz_builtin_float is used in this example? https://github.com/python/cpython/blob/82235449b85165add62c1b200299456a50a1d097/Modules/_xxtestfuzz/README.rst#L34C9-L34C41 It is better to use $test_name. Or even better $fuzz_test_name to have a common prefix.

Linked PRs

Activity

  1. added
    type-bugAn unexpected behavior, bug, or error
    testsTests in the Lib/test dir
    docsDocumentation in the Doc dir
    on Jun 26, 2024
  2. self-assigned this
    on Jun 26, 2024
  3. added a commit that references this issue on Jun 26, 2024
  4. added a commit that references this issue on Sep 16, 2024
  5. added 2 commits that reference this issue on Sep 16, 2024
  6. added a commit that references this issue on Sep 16, 2024
  7. added a commit that references this issue on Sep 22, 2024
  8. added a commit that references this issue on Sep 24, 2024
  9. hugovk commented on Jan 7, 2025

    @hugovk
    Member

    PR merged and backported 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

docsDocumentation in the Doc dirtestsTests in the Lib/test dirtype-bugAn unexpected behavior, bug, or error

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions