Skip to content

docs: add Troubleshooting section to README #271

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.

Sign up for GitHub

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

Open
Nortaq-PlayNexus wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add Troubleshooting section to README #271

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,3 +64,12 @@ Tests use ``unittest`` (not pytest)::

Contributions to any part of fusil are welcome, but active development and CI focus on the
Python fuzzer.

Troubleshooting
===============

If `python -m unittest discover -s tests` fails with `ModuleNotFoundError: No module named 'ptrace'`, install the hard dependency::

pip install python-ptrace

For `--tsan` runs, ensure you use a free-threaded CPython built with `--with-thread-sanitizer` and set `PYTHON_GIL=0` as documented in `doc/tsan-mode-plan.md`.