From 524ad5e30fb66ee2f03547b2d9f5c67bccdc8534 Mon Sep 17 00:00:00 2001 From: Andrew Burgess Date: Thu, 31 Mar 2022 18:19:23 +0100 Subject: gdb: update comments throughout reggroups.{c,h} files This commit updates the comments in the gdb/reggroups.{c,h} files. Fill in some missing comments, correct a few comments that were not clear, and where we had comments duplicated between .c and .h files, update the .c to reference the .h. No user visible changes after this commit. --- gdb/reggroups.h | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) (limited to 'gdb/reggroups.h') diff --git a/gdb/reggroups.h b/gdb/reggroups.h index 5f8a8a3..a2b4cc5 100644 --- a/gdb/reggroups.h +++ b/gdb/reggroups.h @@ -24,7 +24,17 @@ struct gdbarch; -enum reggroup_type { USER_REGGROUP, INTERNAL_REGGROUP }; +/* The different register group types. */ +enum reggroup_type { + /* Used for any register group that should be visible to the user. + Architecture specific register groups, as well as most of the default + groups will have this type. */ + USER_REGGROUP, + + /* Used for a few groups that GDB uses while managing machine state. + These groups are mostly hidden from the user. */ + INTERNAL_REGGROUP +}; /* Individual register group. */ @@ -73,7 +83,7 @@ extern const reggroup *reggroup_gdbarch_new (struct gdbarch *gdbarch, const char *name, enum reggroup_type type); -/* Add a register group (with attribute values) to the pre-defined list. */ +/* Add register group GROUP to the list of register groups for GDBARCH. */ extern void reggroup_add (struct gdbarch *gdbarch, const reggroup *group); /* Return the list of all register groups for GDBARCH. */ -- cgit v1.1