Copy comments from gdbarch.sh to gdbarch.h. Fix a number of K&R params.

[deliverable/binutils-gdb.git] / gdb / gdbarch.h

diff --git a/gdb/gdbarch.h b/gdb/gdbarch.h
index bc69f97440e0cf6c235d0152b26f302463b1a512..f78db27cf24461395631f5cc770c13430d73c5ac 100644 (file)
--- a/gdb/gdbarch.h
+++ b/gdb/gdbarch.h
@@ -100,6 +100,8 @@ extern void set_gdbarch_ptr_bit (struct gdbarch *gdbarch, int ptr_bit);
 #endif
 #endif
 
+/*v:1:TARGET_CHAR_BIT:int:char_bit::::8 * sizeof (char):0 */
+
 extern int gdbarch_short_bit (struct gdbarch *gdbarch);
 extern void set_gdbarch_short_bit (struct gdbarch *gdbarch, int short_bit);
 #if GDB_MULTI_ARCH
@@ -231,6 +233,11 @@ extern void set_gdbarch_num_regs (struct gdbarch *gdbarch, int num_regs);
 #endif
 #endif
 
+/* This macro gives the number of pseudo-registers that live in the
+   register namespace but do not get fetched or stored on the target.
+   These pseudo-registers may be aliases for other registers,
+   combinations of other registers, or they may be computed by GDB. */
+
 /* Default (value) for non- multi-arch platforms. */
 #if (!GDB_MULTI_ARCH) && !defined (NUM_PSEUDO_REGS)
 #define NUM_PSEUDO_REGS (0)
@@ -595,6 +602,10 @@ extern void set_gdbarch_register_convert_to_raw (struct gdbarch *gdbarch, gdbarc
 #endif
 #endif
 
+/* This function is called when the value of a pseudo-register needs to
+   be updated.  Typically it will be defined on a per-architecture
+   basis. */
+
 /* Default (function) for non- multi-arch platforms. */
 #if (!GDB_MULTI_ARCH) && !defined (FETCH_PSEUDO_REGISTER)
 #define FETCH_PSEUDO_REGISTER(regnum) (internal_error ("FETCH_PSEUDO_REGISTER"), 0)
@@ -609,6 +620,10 @@ extern void set_gdbarch_fetch_pseudo_register (struct gdbarch *gdbarch, gdbarch_
 #endif
 #endif
 
+/* This function is called when the value of a pseudo-register needs to
+   be set or stored.  Typically it will be defined on a
+   per-architecture basis. */
+
 /* Default (function) for non- multi-arch platforms. */
 #if (!GDB_MULTI_ARCH) && !defined (STORE_PSEUDO_REGISTER)
 #define STORE_PSEUDO_REGISTER(regnum) (internal_error ("STORE_PSEUDO_REGISTER"), 0)
@@ -710,6 +725,8 @@ extern void set_gdbarch_pop_frame (struct gdbarch *gdbarch, gdbarch_pop_frame_ft
 #endif
 #endif
 
+/* I wish that these would just go away.... */
+
 /* Default (function) for non- multi-arch platforms. */
 #if (!GDB_MULTI_ARCH) && !defined (D10V_MAKE_DADDR)
 #define D10V_MAKE_DADDR(x) (internal_error ("D10V_MAKE_DADDR"), 0)