-
-
Notifications
You must be signed in to change notification settings - Fork 9.5k
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
DOC: Add information about leak checking and valgrind #17934
Conversation
7d696c9
to
4a08496
Compare
Hmm, ok this is not the right place, and I didn't realize we actually have a GDB primer: https://17314-908607-gh.circle-artifacts.com/0/doc/build/html/dev/development_environment.html#debugging |
9505f9f
to
490bf5b
Compare
This is not meant to be a fool-proof guide. It isn't and I do not want to expect people to use it... But I realize that I use these things semi-regulary (even if I never bother to remove all wrinkles) and it is good to have the information somewhere so that everyone knows where to look.
490bf5b
to
bfceca9
Compare
OK, just renamed it slightly and added a reference back to the earlier "Debugging" section, so lets see what you think whether this is the right place/scope or not. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few nits, but looks good. We can iterate on this as time goes on.
errors on its own. An additional advantage of a debug build of Python is that | ||
it allows detecting memory leaks. | ||
|
||
A tool to make this easier is `pytest-leaks <https://github.com/abalkin/pytest-leaks>`_, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe move the URL to the end of the section or so?
Co-authored-by: Matti Picus <matti.picus@gmail.com>
Thanks @seberg |
This is not meant to be a fool-proof guide. It isn't and I
do not want to expect people to use it...
But I realize that I use these things semi-regulary (even if I
never bother to remove all wrinkles) and it is good to have the
information somewhere so that everyone knows where to look.
I am not sure I want to smoothen out this much more, there are wrinkles in these tools, there are things that could be figured out/improved that I never bothered to do. I would hope that someone feels like adding that GDB quickstart before these things, but I don't use gdb with breakpoints etc. that often myself (and if usually from the IDE, which may require trickier setup that I am happy to show about, but do not feel like squeezing into docs on the website).