Skip to content

Add documentation for remote debugging with pdb #134260

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

Merged
merged 2 commits into from
May 20, 2025

Follow Lee on X/Twitter - Father, Husband, Serial builder creating AI, crypto, games & web tools. We are friends :) AI Will Come To Life!

Check out: eBank.nz (Art Generator) | Netwrck.com (AI Tools) | Text-Generator.io (AI API) | BitBank.nz (Crypto AI) | ReadingTime (Kids Reading) | RewordGame | BigMultiplayerChess | WebFiddle | How.nz | Helix AI Assistant

Conversation

ivonastojanovic
Copy link
Contributor

Adds a brief note to the pdb help summary about attaching to a running process using the -p option, making the remote debugging feature more visible.

@ivonastojanovic
Copy link
Contributor Author

CC @pablogsal

vstinner
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
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.

Oh, -m pid is not documented at https://docs.python.org/dev/library/pdb.html. You may update this option there as well.

@vstinner vstinner added the needs backport to 3.14 bugs and security fixes label May 19, 2025
@gaogaotiantian
Copy link
Member

Yeah, maybe update the doc file as well.

@python-cla-bot
Copy link

python-cla-bot bot commented May 19, 2025

All commit authors signed the Contributor License Agreement.

@ivonastojanovic ivonastojanovic changed the title Mention remote debugging via -p PID in usage text Add documentation for remote debugging with pdb May 19, 2025
gaogaotiantian
Adds a brief note to the pdb help summary about attaching to a running
process using the -p option, making the remote debugging feature
more visible.
@gaogaotiantian
Copy link
Member

I think normally we have a bot that gives a preview of the docs when we changes the docs, any idea what happened @vstinner ?

@vstinner
Copy link
Member

I think normally we have a bot that gives a preview of the docs when we changes the docs, any idea what happened @vstinner ?

You can click on the "readthedocs" CI to go to the preview doc: https://cpython-previews--134260.org.readthedocs.build/en/134260/library/pdb.html

vstinner
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. Thanks for updating pdb doc as well.

@pablogsal pablogsal merged commit 6856a04 into python:main May 20, 2025
39 checks passed
@miss-islington-app
Copy link

Thanks @pablogsal for merging it 🌮🎉.. I'm working now to backport this PR to: 3.14.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 20, 2025
* Mention remote debugging via -p PID in usage text

Adds a brief note to the pdb help summary about attaching to a running
process using the -p option, making the remote debugging feature
more visible.

* Mention remote debugging in pdb.rst
(cherry picked from commit 6856a04)

Co-authored-by: ivonastojanovic <80911834+ivonastojanovic@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented May 20, 2025

3.14 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label May 20, 2025
@gaogaotiantian
Copy link
Member

I think the part where it explains how to use attach, should be part of the -p option, or it would be kind of weird to have it there.

lkollar pushed a commit to lkollar/cpython that referenced this pull request May 26, 2025
* Mention remote debugging via -p PID in usage text

Adds a brief note to the pdb help summary about attaching to a running
process using the -p option, making the remote debugging feature
more visible.

* Mention remote debugging in pdb.rst
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

Follow Lee on X/Twitter - Father, Husband, Serial builder creating AI, crypto, games & web tools. We are friends :) AI Will Come To Life!

Check out: eBank.nz (Art Generator) | Netwrck.com (AI Tools) | Text-Generator.io (AI API) | BitBank.nz (Crypto AI) | ReadingTime (Kids Reading) | RewordGame | BigMultiplayerChess | WebFiddle | How.nz | Helix AI Assistant

4 participants

Follow Lee on X/Twitter - Father, Husband, Serial builder creating AI, crypto, games & web tools. We are friends :) AI Will Come To Life!

Check out: eBank.nz (Art Generator) | Netwrck.com (AI Tools) | Text-Generator.io (AI API) | BitBank.nz (Crypto AI) | ReadingTime (Kids Reading) | RewordGame | BigMultiplayerChess | WebFiddle | How.nz | Helix AI Assistant