-
-
Notifications
You must be signed in to change notification settings - Fork 11.9k
DOC: improve development debugging doc #16083
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
Conversation
rossbar
left a comment
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.
IMO this is an improvement that provides a little more guidance without becoming a full-blown gdb tutorial. There is a missing space that needs to be fixed and some structural issues (i.e. perhaps moving some text around) that can be discussed, but I'm +1 on the changes in principle.
Co-Authored-By: Ross Barnowski <[email protected]>
Co-Authored-By: Ross Barnowski <[email protected]>
rossbar
left a comment
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 couple more minor changes, but otherwise I think this looks good.
Co-Authored-By: Ross Barnowski <[email protected]>
Co-Authored-By: Ross Barnowski <[email protected]>
|
I'm going to do a quick close/re-open to retrigger the CI |
rossbar
left a comment
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.
After a more careful look at the diff, it seems that some of the original meaning has been altered a bit in the reorganization of the wording. I think it would be best to try to recapture the original meaning that the user should make sure gdb is installed, and if the Python extensions are also installed then additional Python-specific commands are available.
rossbar
left a comment
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.
I still don't think we're quite nailing the wording - I hope I'm not being too obstinate. I've added a wording suggestion that tries to capture my comments.
IMO the big improvement here is related to the examples you've added.
Co-authored-by: Ross Barnowski <[email protected]>
rossbar
left a comment
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.
LGTM - thanks @Qiyu8 for your suggestions in improving the debugging docs! IMO the additions are nice as they help give the user a little more guidance in verifying they have the debugger set up properly for this procedure. I also think the listing of gdb commands is an improvement, even though it's not NumPy/Python specific. We'll see what other reviewers think!
anirudh2290
left a comment
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.
This definitely looks more useful. LGTM!
|
Can some one please guide me how to installed python enabled gdb on windows 10 .? |
Debugging is a critical part of the development process, so its documentation should be more detailed and accurate.