Skip to content

gh-102809: No longer mention Misc/gdbinit in the code #143980

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

Jump to bottom
Merged
vstinner merged 1 commit into from
Jan 19, 2026
Merged

gh-102809: No longer mention Misc/gdbinit in the code #143980

vstinner merged 1 commit into from
Jan 19, 2026
+1 −1

Conversation

@johnslavik
Copy link
Member

@johnslavik johnslavik commented Jan 18, 2026 •
edited by bedevere-app bot
Loading

Misc/gdbinit was removed in GH-102854 (3.12.0a7).

@johnslavik johnslavik added skip news needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Jan 18, 2026
@johnslavik johnslavik changed the title No longer mention Misc/gdbinit in PyObject_Dump code doc No longer mention Misc/gdbinit in the code Jan 18, 2026
StanFromIreland
StanFromIreland reviewed Jan 18, 2026
View reviewed changes
Copy link
Member

@StanFromIreland StanFromIreland left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or fix it like this one was done?

cpython/Doc/howto/gdb_helpers.rst

Line 40 in 63cc125

- GDB 7 or later. (For earlier versions of GDB, see ``Misc/gdbinit`` in the

@johnslavik
Copy link
Member Author

johnslavik commented Jan 18, 2026 •
edited
Loading

Or fix it like this one was done?

cpython/Doc/howto/gdb_helpers.rst

Line 40 in 63cc125

- GDB 7 or later. (For earlier versions of GDB, see ``Misc/gdbinit`` in the

I'm not sure. This comment remains on 3.10, 3.11 and 3.12 branches, would including Misc/gdbinit again be helpful?
Or do you mean mentioning GDB 7?
Or do you have in mind some other specific idea of improving this comment?

We could direct the reader to Doc/howto/gdb_helpers.rst maybe?

@StanFromIreland
Copy link
Member

StanFromIreland commented Jan 18, 2026

Oh I only have the one line shown, I was referring to: "see Misc/gdbinit in the sources of Python 3.11 or earlier."

@johnslavik
Copy link
Member Author

johnslavik commented Jan 18, 2026 •
edited
Loading

Thanks. Personally, I don't find it necessary, because the 3.11 and earlier branches still will include the mention of Misc/gdbinit after we merge this.

@StanFromIreland
Copy link
Member

StanFromIreland commented Jan 18, 2026

Why do those branches matter? The comment is for people on the branches where the file doesn't exist, no?

@johnslavik
Copy link
Member Author

johnslavik commented Jan 18, 2026

Why do those branches matter? The comment is for people on the branches where the file doesn't exist, no?

I was thinking that mentioning Misc/gdbinit would not be useful to people on branches that don't contain the file, because they wouldn't need nor be able to use the file.

If they needed to debug 3.11, they would check it out and the comment would be there.
Unless I am missing something?

@johnslavik
Copy link
Member Author

johnslavik commented Jan 18, 2026

Do you have an example of when this is useful for someone debugging in the 3.13-3.15 branches only?

@ZeroIntensity
Copy link
Member

ZeroIntensity commented Jan 18, 2026

Yeah, I agree with Bartosz here. The mention in the docs was added after Misc/gdbinit was removed, so I think it's intentional to keep that one.

vstinner
vstinner approved these changes Jan 19, 2026
View reviewed changes
Copy link
Member

@vstinner vstinner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@vstinner vstinner changed the title No longer mention Misc/gdbinit in the code gh-102809: No longer mention Misc/gdbinit in the code Jan 19, 2026
@bedevere-app bedevere-app bot mentioned this pull request Jan 19, 2026
Closed
@vstinner vstinner merged commit f84ea11 into python:main Jan 19, 2026
61 checks passed
@miss-islington-app
Copy link

miss-islington-app bot commented Jan 19, 2026

Thanks @johnslavik for the PR, and @vstinner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 19, 2026
@johnslavik @miss-islington
pythongh-102809: No longer mention Misc/gdbinit in the code (python…
8340f58 
…GH-143980)

Fix misleading comment on `PyObject_Dump`.
(cherry picked from commit f84ea1107170988742fbd350123678a5c503c1ad)

Co-authored-by: Bartosz Sławecki <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 19, 2026
@johnslavik @miss-islington
pythongh-102809: No longer mention Misc/gdbinit in the code (python…
34881e4 
…GH-143980)

Fix misleading comment on `PyObject_Dump`.
(cherry picked from commit f84ea11)

Co-authored-by: Bartosz Sławecki <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Jan 19, 2026

GH-144044 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label Jan 19, 2026
@bedevere-app
Copy link

bedevere-app bot commented Jan 19, 2026

GH-144045 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Jan 19, 2026
@vstinner
Copy link
Member

vstinner commented Jan 19, 2026

Merged, thanks for this cleanup.

@johnslavik
Copy link
Member Author

johnslavik commented Jan 19, 2026

@vstinner, thanks for the review and for linking the issue!

vstinner pushed a commit that referenced this pull request Jan 19, 2026
@miss-islington @johnslavik
[3.13] gh-102809: No longer mention Misc/gdbinit in the code (GH-14…
7bca3dd 
…3980) (#144045)

gh-102809: No longer mention `Misc/gdbinit` in the code (GH-143980)

Fix misleading comment on `PyObject_Dump`.
(cherry picked from commit f84ea11)

Co-authored-by: Bartosz Sławecki <[email protected]>
vstinner pushed a commit that referenced this pull request Jan 19, 2026
@miss-islington @johnslavik
[3.14] gh-102809: No longer mention Misc/gdbinit in the code (GH-14…
27256ca 
…3980) (#144044)

gh-102809: No longer mention `Misc/gdbinit` in the code (GH-143980)

Fix misleading comment on `PyObject_Dump`.
(cherry picked from commit f84ea11)

Co-authored-by: Bartosz Sławecki <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@StanFromIreland StanFromIreland StanFromIreland left review comments

@vstinner vstinner vstinner approved these changes

@ZeroIntensity ZeroIntensity ZeroIntensity approved these changes

Assignees

No one assigned

Labels

skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@johnslavik @StanFromIreland @ZeroIntensity @vstinner