]> sourceware.org Git - binutils-gdb.git/commit
[gdb/doc] Fix gdb.unwinder docs
authorTom de Vries <tdevries@suse.de>
Mon, 27 Jan 2025 09:33:28 +0000 (10:33 +0100)
committerTom de Vries <tdevries@suse.de>
Mon, 27 Jan 2025 09:33:28 +0000 (10:33 +0100)
commitbedfbe9f519af0b12279ffbe9b4e6ab2b7fd924d
treea672f2df4a010d33d0951e39ae6c99e82b0277ff
parent2a20abdd819fe58bec8b923cadae17171fd5aeda
[gdb/doc] Fix gdb.unwinder docs

When building gdb with an older makeinfo (4.13), I run into:
...
gdb/doc/python.texi:3015: warning: `(' follows defined name \
  `gdb.unwinder.Unwinder.__init__' instead of whitespace.
gdb/doc/python.texi:3041: warning: `(' follows defined name \
  `gdb.unwinder.FrameId.__init__' instead of whitespace.
...

The warnings are related to these two lines:
...
@defun gdb.unwinder.Unwinder.__init__(name)
  ...
@defun gdb.unwinder.FrameId.__init__(sp, pc, special = @code{None})
...

Indeed, when checking the command and variable index, we can see that it
contains an incorrect entry:
...
  gdb.unwinder.FrameId.__init__(sp,:          Unwinding Frames in Python
...

Fix this by adding a space before the left parenthesis.

Tested by rebuilding the documentation and checking the command and variable
index.
gdb/doc/python.texi
This page took 0.037301 seconds and 5 git commands to generate.