diff mbox series

[PATCHv2,8/8] gdb/doc: update examples in gdb.Progspace and gdb.Objfile docs

Message ID e6c4ffdacff6b09efac4a6a643627bee5948e3c8.1704901918.git.aburgess@redhat.com
State New
Headers
Series Python __repr__() methods and new __dict__ attributes |

Checks

Context Check Description
linaro-tcwg-bot/tcwg_gdb_build--master-aarch64 success Testing passed
linaro-tcwg-bot/tcwg_gdb_build--master-arm success Testing passed
linaro-tcwg-bot/tcwg_gdb_check--master-aarch64 fail Testing failed
linaro-tcwg-bot/tcwg_gdb_check--master-arm fail Testing failed

Commit Message

Andrew Burgess Jan. 10, 2024, 3:54 p.m. UTC 
  This commit updates the Python example code in the gdb.Progspace and
gdb.Objfile sections of the docs.  Changes made:

  1. Use @value{GDBP} for the GDB prompt rather than
  hard-coding (gdB),

  2. Use @group...@end group to split the example code into
  unbreakable chunks, and

  3. Add parenthesis to the Python print() calls in the examples.  In
  Python 2 it was OK to drop the parenthesis, but now GDB is Python 3
  only, example code should include the parenthesis.
---
 gdb/doc/python.texi | 24 +++++++++++++++++-------
 1 file changed, 17 insertions(+), 7 deletions(-)

Comments

Eli Zaretskii Jan. 10, 2024, 4:36 p.m. UTC | #1 
> From: Andrew Burgess <aburgess@redhat.com>
> Cc: Andrew Burgess <aburgess@redhat.com>
> Date: Wed, 10 Jan 2024 15:54:45 +0000
> 
> This commit updates the Python example code in the gdb.Progspace and
> gdb.Objfile sections of the docs.  Changes made:
> 
>   1. Use @value{GDBP} for the GDB prompt rather than
>   hard-coding (gdB),
> 
>   2. Use @group...@end group to split the example code into
>   unbreakable chunks, and
> 
>   3. Add parenthesis to the Python print() calls in the examples.  In
>   Python 2 it was OK to drop the parenthesis, but now GDB is Python 3
>   only, example code should include the parenthesis.
> ---
>  gdb/doc/python.texi | 24 +++++++++++++++++-------
>  1 file changed, 17 insertions(+), 7 deletions(-)

This is okay, thanks.

Approved-By: Eli Zaretskii <eliz@gnu.org>
diff mbox series

Patch

diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index 40803274a27..0b240c76dce 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -5416,13 +5416,16 @@ 
 will be loaded.
 
 @smallexample
-(gdb) python
+(@value{GDBP}) python
+@group
 def clear_objfiles_handler(event):
     event.progspace.expensive_computation = None
 def expensive(symbol):
     """A mock routine to perform an "expensive" computation on symbol."""
     print ("Computing the answer to the ultimate question ...")
     return 42
+@end group
+@group
 def new_objfile_handler(event):
     objfile = event.new_objfile
     progspace = objfile.progspace
@@ -5437,15 +5440,18 @@ 
 gdb.events.clear_objfiles.connect(clear_objfiles_handler)
 gdb.events.new_objfile.connect(new_objfile_handler)
 end
-(gdb) file /tmp/hello
+@end group
+@group
+(@value{GDBP}) file /tmp/hello
 Reading symbols from /tmp/hello...
 Computing the answer to the ultimate question ...
-(gdb) python print gdb.current_progspace().expensive_computation
+(@value{GDBP}) python print(gdb.current_progspace().expensive_computation)
 42
-(gdb) run
+(@value{GDBP}) run
 Starting program: /tmp/hello
 Hello.
 [Inferior 1 (process 4242) exited normally]
+@end group
 @end smallexample
 
 @node Objfiles In Python
@@ -5576,17 +5582,21 @@ 
 loaded the objfile.
 
 @smallexample
-(gdb) python
+@group
+(@value{GDBP}) python
 import datetime
 def new_objfile_handler(event):
     # Set the time_loaded attribute of the new objfile.
     event.new_objfile.time_loaded = datetime.datetime.today()
 gdb.events.new_objfile.connect(new_objfile_handler)
 end
-(gdb) file ./hello
+@end group
+@group
+(@value{GDBP}) file ./hello
 Reading symbols from ./hello...
-(gdb) python print gdb.objfiles()[0].time_loaded
+(@value{GDBP}) python print(gdb.objfiles()[0].time_loaded)
 2014-10-09 11:41:36.770345
+@end group
 @end smallexample
 
 A @code{gdb.Objfile} object has the following methods: