cpython/Doc/howto
Miss Islington (bot) 73921f4c57
[3.12] gh-89480: Document the gdb helpers (GH-115657) (GH-115857)
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 59057ce55a)

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>
2024-02-23 17:32:42 +01:00
..
annotations.rst [3.12] gh-101100: Improve documentation on function attributes (GH-112933) (#112974) 2023-12-12 10:10:27 +00:00
argparse.rst [3.12] gh-54738: Add argparse i18n howto (GH-104562) (#107102) 2023-07-23 11:36:10 +02:00
clinic.rst [3.12] GH-107518: Remove the Argument Clinic How-To (#109900) (#110760) 2023-10-12 09:37:37 +00:00
cporting.rst gh-91838: Use HTTPS links in docs for resources which redirect to HTTPS (GH-95527) 2022-08-04 10:13:49 +03:00
curses.rst [3.12] gh-101100: Sphinx warnings: pick the low hanging fruits (GH-107386) (GH-107419) 2023-07-29 09:16:27 +03:00
descriptor.rst [3.12] Make the title match the content (GH-115702) (gh-115703) 2024-02-20 07:58:53 +00:00
enum.rst [3.12] [Enum] update class creation for RuntimeError changes (GH-111815) (GH-112526) 2023-11-29 13:49:52 -08:00
functional.rst [3.12] gh-101100: Fix some broken sphinx references (GH-107095) (#107103) 2023-07-23 12:00:31 +02:00
gdb_helpers.rst [3.12] gh-89480: Document the gdb helpers (GH-115657) (GH-115857) 2024-02-23 17:32:42 +01:00
index.rst [3.12] gh-89480: Document the gdb helpers (GH-115657) (GH-115857) 2024-02-23 17:32:42 +01:00
instrumentation.rst [3.12] gh-110631: Fix reST indentation (GH-110724) (#110738) 2023-10-11 23:12:36 +02:00
ipaddress.rst bpo-44740: Make minor edits to lowercasing "internet" and "web". (GH-27385) 2021-07-27 10:57:52 +02:00
isolating-extensions.rst [3.12] gh-101100: Fix Sphinx warnings in howto/isolating-extensions.rst (GH-113493) (#113497) 2023-12-26 19:46:40 +00:00
logging-cookbook.rst [3.12] gh-115233: Fix an example in the Logging Cookbook (GH-115325) (GH-115355) 2024-02-12 18:29:48 +00:00
logging.rst [3.12] gh-101100: Fix sphinx warnings in howto/logging.rst (GH-114846) (#114878) 2024-02-01 20:45:51 +00:00
logging_flow.png Optimize images by IMGbot (GH-21348) 2022-02-04 15:49:43 +09:00
perf_profiling.rst [3.12] Fix typo in perf profiling docs (GH-112112) (#112117) 2023-11-15 15:48:04 +00:00
pyporting.rst [3.12] gh-114785: Remove content from Porting from Python2 how-to (GH-114805) (GH-115327) 2024-02-21 13:49:36 +01:00
regex.rst [3.12] gh-110383: Italicize variable name (GH-111206) (#111207) 2023-10-23 11:11:41 +03:00
sockets.rst Doc: Update references and examples of old, unsupported OSes and uarches (GH-92791) 2022-06-09 15:55:06 +02:00
sorting.rst [3.12] Make the title match the content (GH-115702) (gh-115703) 2024-02-20 07:58:53 +00:00
unicode.rst [3.12] gh-101100: Fix some broken sphinx references (GH-107095) (#107103) 2023-07-23 12:00:31 +02:00
urllib2.rst [3.12] gh-101100: Fix Sphinx warnings in howto/urllib2.rst and library/http.client.rst (GH-114060) (#114063) 2024-01-14 21:14:08 +00:00