gh-89480: Document the gdb helpers #115657

pablogsal · 2024-02-19T13:57:49Z

Issue: Document the removal the usage of the C stack in Python to Python calls #89480

Content adapted from https://devguide.python.org/development-tools/gdb/# and https://wiki.python.org/moin/DebuggingWithGdb

📚 Documentation preview 📚: https://cpython-previews--115657.org.readthedocs.build/

pablogsal · 2024-02-19T13:58:05Z

CC: @encukou

encukou · 2024-02-19T15:59:02Z

Thank you! I'll update this for recent GDB, and then we can perhaps point the devguide to it.

To everyone else: Please don't add GitHub suggestions, they might be lost.

encukou · 2024-02-19T16:59:40Z

I'm signing off for the day. Here's a first pass, I'll finish tomorrow.
It's safe to add suggestions now, if anyone wants to do that.

encukou · 2024-02-20T12:29:17Z

Ready for review.

Diátaxis-wise, this leans toward being a reference rather than a how-to guide. I'm not sure how to quickly handle that -- the document assumes you know debugging with GDB, and only provides a few details.
IMO, adding it would be an improvement, and restructuring can be done later.

Once merged, the devguide page should be updated to point here, and retain only the parts specific to CPython core (test_gdb & tips).

hugovk

Some typos found with https://github.com/codespell-project/codespell

Doc/howto/gdb_helpers.rst

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>

ezio-melotti

I just skimmed through it and left a few comments about the high-level structure of the document and its headers.

Doc/howto/gdb_helpers.rst

ezio-melotti · 2024-02-20T16:54:43Z

Doc/howto/gdb_helpers.rst

+   You can also add multiple paths, separated by ``:``.
+
+
+Linux distros


This title is not very descriptive -- maybe

Suggested change

Linux distros

Installing debug information package on Linux

If this only works on Linux, you could just use:

Suggested change

Linux distros

Installing Python debug information package

and state in the first paragraph that these are only available on Linux.

Setting things up depends on how you got your Python. These are examples for two common cases: source builds, and Linux distros. (No Windows or Mac, you wouldn't typically use GDB there.)

ezio-melotti · 2024-02-20T16:56:28Z

Doc/howto/gdb_helpers.rst

+Note that even if the instructions match your system, they might be outdated.
+
+
+Python built from source


If this is a prerequisite, it should be listed above, and this section would just explain how to do it, with a title like:

Suggested change

Python built from source

Building Python from source

I'd keep Python itself is a prerequisite for the prerequisites. The guide doesn't tell you how to get it, but how to set things up for it.
Hopefully “Setup with Python built from source” is clearer.

Doc/howto/gdb_helpers.rst

ezio-melotti · 2024-02-20T16:59:43Z

Doc/howto/gdb_helpers.rst

+you generally do need to install the debug info package separately.
+
+
+Debug build and Development mode


This title could also be more "action-oriented":

Suggested change

Debug build and Development mode

Building Python in "debug" and "development" mode

or

Suggested change

Debug build and Development mode

Enabling "debug" and "development" mode

This could also be a sub-section of the "Building Python from source" section above. You wouldn't want to read that and build everything and then discover that you have to do it again with debug/dev mode enabled.

You do want both: for debugging extensions it's sometimes easier to use the production build.
And these are not specific to source builds.

ezio-melotti · 2024-02-20T17:02:03Z

Doc/howto/gdb_helpers.rst

+make the process easier.
+
+
+Using the ``python-gdb`` extension


This seems to be the actual how-to.

You could also add a short introductory paragraph like "After installing the dependencies, you can now use the `python-gdb extension to ...".

The previous section tells you how to set things up, this tessl you how to use it :)

Doc/howto/gdb_helpers.rst

willingc · 2024-02-20T20:16:01Z

From my discord post:

I think that the Title is too vague (GDB support) and the first paragraph should be recrafted to clearly articulate the purpose of the document, what the reader will learn (How to use GDB helpers to debug?), and when using this doc would be helpful.

I understand that you wish to move this forward quickly @encukou. I would like to see:

a more specific title (perhaps Debugging CPython Internals with GDB)
a note in the introduction section that this document is a consolidation of content from the devguide and the wiki
guidance for the reader
- who would find this content useful
- when would they use gdb and specifically the python helper
- what will they learn if they read the rest of the document

willingc

Let's come up with a better title and address the introduction section that I mention in my comments. After that, I think this will be ready to merge from my vantage point.

I'm less concerned about where this falls diataxis-wise and more concerned that we have clarity of its purpose for the reader and for future disambiguation of the old-style HOWTOs.

bedevere-app · 2024-02-20T20:17:33Z

When you're done making the requested changes, leave the comment: I have made the requested changes; please review again.

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

encukou · 2024-02-21T12:41:04Z

Thanks! Your perspectives are very helpful here; I'm too deep in :)
I want to move it forward, it doesn't really need to be quick. It's a deferred release blocker for 3.11, a few more months won't matter.

@willingc

guidance for the reader

who would find this content useful

when would they use gdb and specifically the python helper

what will they learn if they read the rest of the document

I thought the first section covers exactly these questions. When you have the time, could you please be more specific about how it should be written?

willingc · 2024-02-21T17:23:23Z

@encukou I like the changes that you have made to the headings.

I thought the first section covers exactly these questions. When you have the time, could you please be more specific about how it should be written?

I think it is being more explicit to the reader. I will leave an example in the comments here later today. Thanks!

willingc · 2024-02-21T18:13:39Z

@encukou This is more along the lines of what I was thinking:

high-level what
why this is needed
who would use this information

It takes most of the info that you wrote but breaks it into more logical chunks for a reader, such a scientist writing and debugging a C extension, who has not yet used the the Python extension with GDB.

This document explains how GDB and the Python extension, ``python-gdb.py``, can
be used together to debug CPython extensions and the CPython interpreter itself.

When debugging low-level problems such as crashes or deadlocks, a low-level debugger,
such as GDB, is useful to diagnose and correct the issue. By default, GDB (or any
of its front-ends) doesn't support high-level information specific to the CPython
interpreter.

The ``python-gdb.py`` extension adds CPython interpreter information to GDB. The
extension helps introspect a currently executing Python function. Given
a Python object represented by a standard PyObject * pointer, the extension surfaces
the type and value of the object.

Developers who are working on CPython extensions or tinkering with parts of CPython
that are written in C can use this document to learn how to use GDB with the
``python-gdb.py`` extension.

.. note::
    
   This document assumes that you are familiar with the basics of GDB and the
   CPython C API. It consolidates guidance from the CPython devguide
   and the Python wiki.

willingc

See sample wording in my comment.

Co-Authored-By: Carol Willing <carolcode@willingconsulting.com>

encukou · 2024-02-23T09:53:40Z

Thank you for the concrete wording! I hope it will help future me write better introductions on my own :)

I edited your suggestion for technical details, and to highlight that this doesn't teach how to use GDB itself -- the guide (and the extension) are mainly useful for people who already use GDB.

I take your GitHub approval as a sign that you don't necessarily want to review again, so, I'll merge on Monday if there are no objections.

willingc · 2024-02-23T14:46:47Z

Thanks @encukou for the touchups to my wording. I'm fine with the PR. 🚢

encukou · 2024-02-23T16:13:54Z

Thank you!

miss-islington-app · 2024-02-23T16:14:10Z

Thanks @pablogsal for the PR, and @encukou for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

miss-islington-app · 2024-02-23T16:14:10Z

Thanks @pablogsal for the PR, and @encukou for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

Content adapted from https://devguide.python.org/development-tools/gdb/GH- and https://wiki.python.org/moin/DebuggingWithGdb. The original content on the Wiki page came from gdb debug help used by the Launchpad (https://launchpad.net/) team. Thanks to Anatoly Techtonik and user `rmf` for substantial improvements to the Wiki page. The history of the Devguide page follows (with log entries expanded for major content contributions): Hugo van Kemenade, Sat Dec 30 21:22:04 2023 +0200 Hugo van Kemenade, Fri Dec 8 12:04:32 2023 +0200 Erlend E. Aasland & Hugo van Kemenade, Tue Aug 8 22:05:34 2023 +0200 Satish Mishra, Sat Feb 11 13:54:57 2023 +0530 Hugo van Kemenade, Fri Dec 23 17:33:33 2022 +0200 Skip Montanaro, Hugo, Erlend, & Ezio, Fri Nov 4 05:04:23 2022 -0500 Add a GDB tips section to Advanced Tools (pythonGH-977) Adam Turner, Wed Jun 15 21:19:23 2022 +0100 Adam Turner, Tue Jun 14 11:12:26 2022 +0100 Suriyaa, Fri Jun 8 19:39:23 2018 +0200 Jeff Allen, Tue Oct 24 18:12:53 2017 +0100 Jeff Allen, Fri Oct 13 13:43:43 2017 +0100 Mariatta, Wed Jan 4 09:14:55 2017 -0800 Carol Willing, Mon Sep 26 14:50:54 2016 -0700 Zachary Ware, Thu Jul 21 10:42:23 2016 -0500 Georg Brandl, Mon Nov 3 11:28:19 2014 +0100 Add instruction how to activate python-gdb.py Georg Brandl, Sun Mar 9 10:32:01 2014 +0100 Georg Brandl, Tue Apr 3 09:12:53 2012 +0200 Georg Brandl, Sat Mar 5 17:32:35 2011 +0100 Dave Malcolm, Fri Jan 21 12:34:09 2011 -0500 Add documentation on the gdb extension commands provided in libpython.py I adapted this from documentation I wrote for the Fedora wiki: https://fedoraproject.org/wiki/Features/EasierPythonDebuggingGH-New_gdb_commands reformatting it as rst, and making other minor changes Brett Cannon, Thu Jan 20 15:16:52 2011 -0800 Dave Malcolm, Thu Jan 20 16:17:23 2011 -0500 Add some notes on the gdb pretty-printer hooks Antoine Pitrou, Thu Jan 20 21:17:49 2011 +0100 Give an example backtrace Antoine Pitrou, Thu Jan 20 21:03:06 2011 +0100 Expand explanations about gdb support Brett Cannon, Thu Jan 20 11:33:36 2011 -0800 Tweak the gdb support title to fit in better with the devguide. Brett Cannon, Mon Jan 17 21:12:54 2011 +0000 Short README on gdb support. (cherry picked from commit 59057ce) Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com> Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com> Co-authored-by: anatoly techtonik <techtonik@gmail.com> Co-authored-by: Antoine Pitrou <solipsis@pitrou.net> Co-authored-by: Brett Cannon <brett@python.org> Co-authored-by: Carol Willing <carolcode@willingconsulting.com> Co-authored-by: Dave Malcolm <dmalcolm@redhat.com> Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com> Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> Co-authored-by: Georg Brandl <georg@python.org> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: Jeff Allen <ja.py@farowl.co.uk> Co-authored-by: Mariatta <Mariatta@users.noreply.github.com> Co-authored-by: Petr Viktorin <encukou@gmail.com> Co-authored-by: Satish Mishra <7506satish@gmail.com> Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com> Co-authored-by: Suriyaa <isc.suriyaa@gmail.com> Co-authored-by: Zachary Ware <zachary.ware@gmail.com>

bedevere-app · 2024-02-23T16:14:29Z

GH-115857 is a backport of this pull request to the 3.12 branch.

Content adapted from https://devguide.python.org/development-tools/gdb/GH- and https://wiki.python.org/moin/DebuggingWithGdb. The original content on the Wiki page came from gdb debug help used by the Launchpad (https://launchpad.net/) team. Thanks to Anatoly Techtonik and user `rmf` for substantial improvements to the Wiki page. The history of the Devguide page follows (with log entries expanded for major content contributions): Hugo van Kemenade, Sat Dec 30 21:22:04 2023 +0200 Hugo van Kemenade, Fri Dec 8 12:04:32 2023 +0200 Erlend E. Aasland & Hugo van Kemenade, Tue Aug 8 22:05:34 2023 +0200 Satish Mishra, Sat Feb 11 13:54:57 2023 +0530 Hugo van Kemenade, Fri Dec 23 17:33:33 2022 +0200 Skip Montanaro, Hugo, Erlend, & Ezio, Fri Nov 4 05:04:23 2022 -0500 Add a GDB tips section to Advanced Tools (pythonGH-977) Adam Turner, Wed Jun 15 21:19:23 2022 +0100 Adam Turner, Tue Jun 14 11:12:26 2022 +0100 Suriyaa, Fri Jun 8 19:39:23 2018 +0200 Jeff Allen, Tue Oct 24 18:12:53 2017 +0100 Jeff Allen, Fri Oct 13 13:43:43 2017 +0100 Mariatta, Wed Jan 4 09:14:55 2017 -0800 Carol Willing, Mon Sep 26 14:50:54 2016 -0700 Zachary Ware, Thu Jul 21 10:42:23 2016 -0500 Georg Brandl, Mon Nov 3 11:28:19 2014 +0100 Add instruction how to activate python-gdb.py Georg Brandl, Sun Mar 9 10:32:01 2014 +0100 Georg Brandl, Tue Apr 3 09:12:53 2012 +0200 Georg Brandl, Sat Mar 5 17:32:35 2011 +0100 Dave Malcolm, Fri Jan 21 12:34:09 2011 -0500 Add documentation on the gdb extension commands provided in libpython.py I adapted this from documentation I wrote for the Fedora wiki: https://fedoraproject.org/wiki/Features/EasierPythonDebuggingGH-New_gdb_commands reformatting it as rst, and making other minor changes Brett Cannon, Thu Jan 20 15:16:52 2011 -0800 Dave Malcolm, Thu Jan 20 16:17:23 2011 -0500 Add some notes on the gdb pretty-printer hooks Antoine Pitrou, Thu Jan 20 21:17:49 2011 +0100 Give an example backtrace Antoine Pitrou, Thu Jan 20 21:03:06 2011 +0100 Expand explanations about gdb support Brett Cannon, Thu Jan 20 11:33:36 2011 -0800 Tweak the gdb support title to fit in better with the devguide. Brett Cannon, Mon Jan 17 21:12:54 2011 +0000 Short README on gdb support. (cherry picked from commit 59057ce) Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com> Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com> Co-authored-by: anatoly techtonik <techtonik@gmail.com> Co-authored-by: Antoine Pitrou <solipsis@pitrou.net> Co-authored-by: Brett Cannon <brett@python.org> Co-authored-by: Carol Willing <carolcode@willingconsulting.com> Co-authored-by: Dave Malcolm <dmalcolm@redhat.com> Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com> Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> Co-authored-by: Georg Brandl <georg@python.org> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: Jeff Allen <ja.py@farowl.co.uk> Co-authored-by: Mariatta <Mariatta@users.noreply.github.com> Co-authored-by: Petr Viktorin <encukou@gmail.com> Co-authored-by: Satish Mishra <7506satish@gmail.com> Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com> Co-authored-by: Suriyaa <isc.suriyaa@gmail.com> Co-authored-by: Zachary Ware <zachary.ware@gmail.com>

bedevere-app · 2024-02-23T16:14:34Z

GH-115858 is a backport of this pull request to the 3.11 branch.

gh-89480: Document the gdb helpers (GH-115657) Content adapted from https://devguide.python.org/development-tools/gdb/GH- and https://wiki.python.org/moin/DebuggingWithGdb. The original content on the Wiki page came from gdb debug help used by the Launchpad (https://launchpad.net/) team. Thanks to Anatoly Techtonik and user `rmf` for substantial improvements to the Wiki page. The history of the Devguide page follows (with log entries expanded for major content contributions): Hugo van Kemenade, Sat Dec 30 21:22:04 2023 +0200 Hugo van Kemenade, Fri Dec 8 12:04:32 2023 +0200 Erlend E. Aasland & Hugo van Kemenade, Tue Aug 8 22:05:34 2023 +0200 Satish Mishra, Sat Feb 11 13:54:57 2023 +0530 Hugo van Kemenade, Fri Dec 23 17:33:33 2022 +0200 Skip Montanaro, Hugo, Erlend, & Ezio, Fri Nov 4 05:04:23 2022 -0500 Add a GDB tips section to Advanced Tools (GH-977) Adam Turner, Wed Jun 15 21:19:23 2022 +0100 Adam Turner, Tue Jun 14 11:12:26 2022 +0100 Suriyaa, Fri Jun 8 19:39:23 2018 +0200 Jeff Allen, Tue Oct 24 18:12:53 2017 +0100 Jeff Allen, Fri Oct 13 13:43:43 2017 +0100 Mariatta, Wed Jan 4 09:14:55 2017 -0800 Carol Willing, Mon Sep 26 14:50:54 2016 -0700 Zachary Ware, Thu Jul 21 10:42:23 2016 -0500 Georg Brandl, Mon Nov 3 11:28:19 2014 +0100 Add instruction how to activate python-gdb.py Georg Brandl, Sun Mar 9 10:32:01 2014 +0100 Georg Brandl, Tue Apr 3 09:12:53 2012 +0200 Georg Brandl, Sat Mar 5 17:32:35 2011 +0100 Dave Malcolm, Fri Jan 21 12:34:09 2011 -0500 Add documentation on the gdb extension commands provided in libpython.py I adapted this from documentation I wrote for the Fedora wiki: https://fedoraproject.org/wiki/Features/EasierPythonDebuggingGH-New_gdb_commands reformatting it as rst, and making other minor changes Brett Cannon, Thu Jan 20 15:16:52 2011 -0800 Dave Malcolm, Thu Jan 20 16:17:23 2011 -0500 Add some notes on the gdb pretty-printer hooks Antoine Pitrou, Thu Jan 20 21:17:49 2011 +0100 Give an example backtrace Antoine Pitrou, Thu Jan 20 21:03:06 2011 +0100 Expand explanations about gdb support Brett Cannon, Thu Jan 20 11:33:36 2011 -0800 Tweak the gdb support title to fit in better with the devguide. Brett Cannon, Mon Jan 17 21:12:54 2011 +0000 Short README on gdb support. (cherry picked from commit 59057ce) Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com> Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com> Co-authored-by: anatoly techtonik <techtonik@gmail.com> Co-authored-by: Antoine Pitrou <solipsis@pitrou.net> Co-authored-by: Brett Cannon <brett@python.org> Co-authored-by: Carol Willing <carolcode@willingconsulting.com> Co-authored-by: Dave Malcolm <dmalcolm@redhat.com> Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com> Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> Co-authored-by: Georg Brandl <georg@python.org> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: Jeff Allen <ja.py@farowl.co.uk> Co-authored-by: Mariatta <Mariatta@users.noreply.github.com> Co-authored-by: Petr Viktorin <encukou@gmail.com> Co-authored-by: Satish Mishra <7506satish@gmail.com> Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com> Co-authored-by: Suriyaa <isc.suriyaa@gmail.com> Co-authored-by: Zachary Ware <zachary.ware@gmail.com>

Content adapted from https://devguide.python.org/development-tools/gdb/GH- and https://wiki.python.org/moin/DebuggingWithGdb. The original content on the Wiki page came from gdb debug help used by the Launchpad (https://launchpad.net/) team. Thanks to Anatoly Techtonik and user `rmf` for substantial improvements to the Wiki page. The history of the Devguide page follows (with log entries expanded for major content contributions): Hugo van Kemenade, Sat Dec 30 21:22:04 2023 +0200 Hugo van Kemenade, Fri Dec 8 12:04:32 2023 +0200 Erlend E. Aasland & Hugo van Kemenade, Tue Aug 8 22:05:34 2023 +0200 Satish Mishra, Sat Feb 11 13:54:57 2023 +0530 Hugo van Kemenade, Fri Dec 23 17:33:33 2022 +0200 Skip Montanaro, Hugo, Erlend, & Ezio, Fri Nov 4 05:04:23 2022 -0500 Add a GDB tips section to Advanced Tools (GH-977) Adam Turner, Wed Jun 15 21:19:23 2022 +0100 Adam Turner, Tue Jun 14 11:12:26 2022 +0100 Suriyaa, Fri Jun 8 19:39:23 2018 +0200 Jeff Allen, Tue Oct 24 18:12:53 2017 +0100 Jeff Allen, Fri Oct 13 13:43:43 2017 +0100 Mariatta, Wed Jan 4 09:14:55 2017 -0800 Carol Willing, Mon Sep 26 14:50:54 2016 -0700 Zachary Ware, Thu Jul 21 10:42:23 2016 -0500 Georg Brandl, Mon Nov 3 11:28:19 2014 +0100 Add instruction how to activate python-gdb.py Georg Brandl, Sun Mar 9 10:32:01 2014 +0100 Georg Brandl, Tue Apr 3 09:12:53 2012 +0200 Georg Brandl, Sat Mar 5 17:32:35 2011 +0100 Dave Malcolm, Fri Jan 21 12:34:09 2011 -0500 Add documentation on the gdb extension commands provided in libpython.py I adapted this from documentation I wrote for the Fedora wiki: https://fedoraproject.org/wiki/Features/EasierPythonDebuggingGH-New_gdb_commands reformatting it as rst, and making other minor changes Brett Cannon, Thu Jan 20 15:16:52 2011 -0800 Dave Malcolm, Thu Jan 20 16:17:23 2011 -0500 Add some notes on the gdb pretty-printer hooks Antoine Pitrou, Thu Jan 20 21:17:49 2011 +0100 Give an example backtrace Antoine Pitrou, Thu Jan 20 21:03:06 2011 +0100 Expand explanations about gdb support Brett Cannon, Thu Jan 20 11:33:36 2011 -0800 Tweak the gdb support title to fit in better with the devguide. Brett Cannon, Mon Jan 17 21:12:54 2011 +0000 Short README on gdb support. (cherry picked from commit 59057ce) Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com> Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com> Co-authored-by: anatoly techtonik <techtonik@gmail.com> Co-authored-by: Antoine Pitrou <solipsis@pitrou.net> Co-authored-by: Brett Cannon <brett@python.org> Co-authored-by: Carol Willing <carolcode@willingconsulting.com> Co-authored-by: Dave Malcolm <dmalcolm@redhat.com> Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com> Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> Co-authored-by: Georg Brandl <georg@python.org> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: Jeff Allen <ja.py@farowl.co.uk> Co-authored-by: Mariatta <Mariatta@users.noreply.github.com> Co-authored-by: Petr Viktorin <encukou@gmail.com> Co-authored-by: Satish Mishra <7506satish@gmail.com> Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com> Co-authored-by: Suriyaa <isc.suriyaa@gmail.com> Co-authored-by: Zachary Ware <zachary.ware@gmail.com> * Update (downdate?) this to Python 3.11 --------- Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com> Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com> Co-authored-by: anatoly techtonik <techtonik@gmail.com> Co-authored-by: Antoine Pitrou <solipsis@pitrou.net> Co-authored-by: Brett Cannon <brett@python.org> Co-authored-by: Carol Willing <carolcode@willingconsulting.com> Co-authored-by: Dave Malcolm <dmalcolm@redhat.com> Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com> Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> Co-authored-by: Georg Brandl <georg@python.org> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: Jeff Allen <ja.py@farowl.co.uk> Co-authored-by: Mariatta <Mariatta@users.noreply.github.com> Co-authored-by: Petr Viktorin <encukou@gmail.com> Co-authored-by: Satish Mishra <7506satish@gmail.com> Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com> Co-authored-by: Suriyaa <isc.suriyaa@gmail.com> Co-authored-by: Zachary Ware <zachary.ware@gmail.com>

Content adapted from https://devguide.python.org/development-tools/gdb/# and https://wiki.python.org/moin/DebuggingWithGdb. The original content on the Wiki page came from gdb debug help used by the Launchpad (https://launchpad.net/) team. Thanks to Anatoly Techtonik and user `rmf` for substantial improvements to the Wiki page. The history of the Devguide page follows (with log entries expanded for major content contributions): Hugo van Kemenade, Sat Dec 30 21:22:04 2023 +0200 Hugo van Kemenade, Fri Dec 8 12:04:32 2023 +0200 Erlend E. Aasland & Hugo van Kemenade, Tue Aug 8 22:05:34 2023 +0200 Satish Mishra, Sat Feb 11 13:54:57 2023 +0530 Hugo van Kemenade, Fri Dec 23 17:33:33 2022 +0200 Skip Montanaro, Hugo, Erlend, & Ezio, Fri Nov 4 05:04:23 2022 -0500 Add a GDB tips section to Advanced Tools (python#977) Adam Turner, Wed Jun 15 21:19:23 2022 +0100 Adam Turner, Tue Jun 14 11:12:26 2022 +0100 Suriyaa, Fri Jun 8 19:39:23 2018 +0200 Jeff Allen, Tue Oct 24 18:12:53 2017 +0100 Jeff Allen, Fri Oct 13 13:43:43 2017 +0100 Mariatta, Wed Jan 4 09:14:55 2017 -0800 Carol Willing, Mon Sep 26 14:50:54 2016 -0700 Zachary Ware, Thu Jul 21 10:42:23 2016 -0500 Georg Brandl, Mon Nov 3 11:28:19 2014 +0100 Add instruction how to activate python-gdb.py Georg Brandl, Sun Mar 9 10:32:01 2014 +0100 Georg Brandl, Tue Apr 3 09:12:53 2012 +0200 Georg Brandl, Sat Mar 5 17:32:35 2011 +0100 Dave Malcolm, Fri Jan 21 12:34:09 2011 -0500 Add documentation on the gdb extension commands provided in libpython.py I adapted this from documentation I wrote for the Fedora wiki: https://fedoraproject.org/wiki/Features/EasierPythonDebugging#New_gdb_commands reformatting it as rst, and making other minor changes Brett Cannon, Thu Jan 20 15:16:52 2011 -0800 Dave Malcolm, Thu Jan 20 16:17:23 2011 -0500 Add some notes on the gdb pretty-printer hooks Antoine Pitrou, Thu Jan 20 21:17:49 2011 +0100 Give an example backtrace Antoine Pitrou, Thu Jan 20 21:03:06 2011 +0100 Expand explanations about gdb support Brett Cannon, Thu Jan 20 11:33:36 2011 -0800 Tweak the gdb support title to fit in better with the devguide. Brett Cannon, Mon Jan 17 21:12:54 2011 +0000 Short README on gdb support. Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com> Co-authored-by: anatoly techtonik <techtonik@gmail.com> Co-authored-by: Antoine Pitrou <solipsis@pitrou.net> Co-authored-by: Brett Cannon <brett@python.org> Co-authored-by: Carol Willing <carolcode@willingconsulting.com> Co-authored-by: Dave Malcolm <dmalcolm@redhat.com> Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com> Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> Co-authored-by: Georg Brandl <georg@python.org> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: Jeff Allen <ja.py@farowl.co.uk> Co-authored-by: Mariatta <Mariatta@users.noreply.github.com> Co-authored-by: Petr Viktorin <encukou@gmail.com> Co-authored-by: Satish Mishra <7506satish@gmail.com> Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com> Co-authored-by: Suriyaa <isc.suriyaa@gmail.com> Co-authored-by: Zachary Ware <zachary.ware@gmail.com>

pythongh-89480: Document the gdb helpers

9fcccce

bedevere-app bot added awaiting core review docs Documentation in the Doc dir skip news labels Feb 19, 2024

bedevere-app bot mentioned this pull request Feb 19, 2024

Document the removal the usage of the C stack in Python to Python calls #89480

Closed

Update info; remove stuff specific to CPython internals

bb74f8c

Another editing pass

4639810

hugovk reviewed Feb 20, 2024

View reviewed changes

Doc/howto/gdb_helpers.rst Outdated Show resolved Hide resolved

Doc/howto/gdb_helpers.rst Outdated Show resolved Hide resolved

Doc/howto/gdb_helpers.rst Outdated Show resolved Hide resolved

Apply suggestions from code review

8acd7a3

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>

ezio-melotti reviewed Feb 20, 2024

View reviewed changes

willingc self-requested a review February 20, 2024 20:16

willingc requested changes Feb 20, 2024

View reviewed changes

bedevere-app bot added awaiting changes and removed awaiting core review labels Feb 20, 2024

encukou and others added 2 commits February 21, 2024 13:22

Apply suggestions from code review

deb10f1

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

Rewordings, heading fixes

c0fc1ac

willingc reviewed Feb 21, 2024

View reviewed changes

willingc approved these changes Feb 21, 2024

View reviewed changes

bedevere-app bot added awaiting merge and removed awaiting changes labels Feb 21, 2024

Rewrite the introduction based on Carol's comment

e646760

Co-Authored-By: Carol Willing <carolcode@willingconsulting.com>

encukou merged commit 59057ce into python:main Feb 23, 2024

bedevere-app bot removed the awaiting merge label Feb 23, 2024

encukou added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Feb 23, 2024

bedevere-app bot removed the needs backport to 3.12 only security fixes label Feb 23, 2024

bedevere-app bot removed the needs backport to 3.11 only security fixes label Feb 23, 2024

		You can also add multiple paths, separated by ``:``.


		Linux distros

		Note that even if the instructions match your system, they might be outdated.


		Python built from source

		you generally do need to install the debug info package separately.


		Debug build and Development mode

	Debug build and Development mode
	Building Python in "debug" and "development" mode

	Debug build and Development mode
	Enabling "debug" and "development" mode

Uh oh!

gh-89480: Document the gdb helpers #115657

gh-89480: Document the gdb helpers #115657

Conversation

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!