This is the mail archive of the gdb-patches@sourceware.org mailing list for the GDB project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

[commit] Document the get_longjmp_target gdbarch method.


Hello,

Upon reviewing a patch, I was telling the contributor that re-documenting
a function implementing a gdbarch hook should not be done, since it
would only duplicate the documentation in gdbarch.h/sh. Except that,
in this case (get_longjmp_target), there wasn't much... Fixed thusly.

gdb/ChangeLog:

        * gdbarch.sh (get_longjmp_target): Add method documentation.
        * gdbarch.h: Regenerate.

Tested by visual inspection (only comments changed), and by rebuilding
GDB.

Checked in.

Thanks,
-- 
Joel

---
 gdb/ChangeLog  | 5 +++++
 gdb/gdbarch.h  | 5 ++++-
 gdb/gdbarch.sh | 7 ++++++-
 3 files changed, 15 insertions(+), 2 deletions(-)

diff --git a/gdb/ChangeLog b/gdb/ChangeLog
index 6ae91ee..3009935 100644
--- a/gdb/ChangeLog
+++ b/gdb/ChangeLog
@@ -1,3 +1,8 @@
+2013-10-17  Joel Brobecker  <brobecker@adacore.com>
+
+	* gdbarch.sh (get_longjmp_target): Add method documentation.
+	* gdbarch.h: Regenerate.
+
 2013-10-16  Tom Tromey  <tromey@redhat.com>
 
 	* dbxread.c (read_dbx_symtab) <bss_ext_symbol>: Remove unused
diff --git a/gdb/gdbarch.h b/gdb/gdbarch.h
index 5d20ea6..b58efc8 100644
--- a/gdb/gdbarch.h
+++ b/gdb/gdbarch.h
@@ -400,7 +400,10 @@ typedef int (gdbarch_cannot_store_register_ftype) (struct gdbarch *gdbarch, int
 extern int gdbarch_cannot_store_register (struct gdbarch *gdbarch, int regnum);
 extern void set_gdbarch_cannot_store_register (struct gdbarch *gdbarch, gdbarch_cannot_store_register_ftype *cannot_store_register);
 
-/* setjmp/longjmp support. */
+/* Determine the address where a longjmp will land and save this address
+   in PC.  Return nonzero on success.
+  
+   FRAME corresponds to the longjmp frame. */
 
 extern int gdbarch_get_longjmp_target_p (struct gdbarch *gdbarch);
 
diff --git a/gdb/gdbarch.sh b/gdb/gdbarch.sh
index 5e46788..644718d 100755
--- a/gdb/gdbarch.sh
+++ b/gdb/gdbarch.sh
@@ -486,8 +486,13 @@ M:void:print_vector_info:struct ui_file *file, struct frame_info *frame, const c
 m:int:register_sim_regno:int reg_nr:reg_nr::legacy_register_sim_regno::0
 m:int:cannot_fetch_register:int regnum:regnum::cannot_register_not::0
 m:int:cannot_store_register:int regnum:regnum::cannot_register_not::0
-# setjmp/longjmp support.
+
+# Determine the address where a longjmp will land and save this address
+# in PC.  Return nonzero on success.
+#
+# FRAME corresponds to the longjmp frame.
 F:int:get_longjmp_target:struct frame_info *frame, CORE_ADDR *pc:frame, pc
+
 #
 v:int:believe_pcc_promotion:::::::
 #
-- 
1.8.1.2


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]