Skip to content

Improve _xxtestfuzz/README.rst #121023

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
sobolevn opened this issue Jun 26, 2024 · 1 comment
Closed

Improve _xxtestfuzz/README.rst #121023

sobolevn opened this issue Jun 26, 2024 · 1 comment
Assignees
Labels
docs Documentation in the Doc dir tests Tests in the Lib/test dir type-bug An unexpected behavior, bug, or error

Comments

@sobolevn
Copy link
Member

sobolevn commented Jun 26, 2024

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

@sobolevn sobolevn added type-bug An unexpected behavior, bug, or error tests Tests in the Lib/test dir docs Documentation in the Doc dir labels Jun 26, 2024
@sobolevn sobolevn self-assigned this Jun 26, 2024
sobolevn added a commit to sobolevn/cpython that referenced this issue Jun 26, 2024
sobolevn added a commit that referenced this issue Sep 16, 2024
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Sep 16, 2024
(cherry picked from commit a9c2bc1)

Co-authored-by: sobolevn <[email protected]>
Co-authored-by: Illia Volochii <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Sep 16, 2024
(cherry picked from commit a9c2bc1)

Co-authored-by: sobolevn <[email protected]>
Co-authored-by: Illia Volochii <[email protected]>
sobolevn added a commit that referenced this issue Sep 16, 2024
gh-121023: Improve `_xxtestfuzz/README.rst` (GH-121024)
(cherry picked from commit a9c2bc1)

Co-authored-by: sobolevn <[email protected]>
Co-authored-by: Illia Volochii <[email protected]>
savannahostrowski pushed a commit to savannahostrowski/cpython that referenced this issue Sep 22, 2024
Yhg1s pushed a commit that referenced this issue Sep 24, 2024
gh-121023: Improve `_xxtestfuzz/README.rst` (GH-121024)
(cherry picked from commit a9c2bc1)

Co-authored-by: sobolevn <[email protected]>
Co-authored-by: Illia Volochii <[email protected]>
@hugovk
Copy link
Member

hugovk commented Jan 7, 2025

PR merged and backported 🚀

@hugovk hugovk closed this as completed Jan 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir tests Tests in the Lib/test dir type-bug An unexpected behavior, bug, or error
Projects
None yet
Development

No branches or pull requests

2 participants