From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from simark.ca by simark.ca with LMTP id kBHMCi0ZRmJQHAAAWB0awg (envelope-from ) for ; Thu, 31 Mar 2022 17:12:13 -0400 Received: by simark.ca (Postfix, from userid 112) id 294E91F163; Thu, 31 Mar 2022 17:12:13 -0400 (EDT) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on simark.ca X-Spam-Level: X-Spam-Status: No, score=-2.0 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,MAILING_LIST_MULTI,RDNS_DYNAMIC,URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.2 Received: from sourceware.org (ip-8-43-85-97.sourceware.org [8.43.85.97]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by simark.ca (Postfix) with ESMTPS id 646FD1E150 for ; Thu, 31 Mar 2022 17:12:12 -0400 (EDT) Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id 088B43898C70 for ; Thu, 31 Mar 2022 21:12:12 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 088B43898C70 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sourceware.org; s=default; t=1648761132; bh=rT5EtuR8CSHEywBpYsEGxV+PVUCu9Vva42XM3/y0R14=; h=To:Subject:Date:In-Reply-To:References:List-Id:List-Unsubscribe: List-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To:Cc: From; b=xz+f54Q7n2TwZo5VUQYgKCHpTMU/fTBnRJU/W4fDjpMGcsHLD+ik8t7o6u9iCGOyF Sh/KJAcHkZJG7gLPwhqQCh7qkOTss+YXKxNWber5CcdGJAXvO18iHL5dFwvGOpCPaO fn5XhMB0ADScvdGrhgth+GXu6xeNLIQmgrRpRuzM= Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by sourceware.org (Postfix) with ESMTPS id C37C23839430 for ; Thu, 31 Mar 2022 21:04:58 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org C37C23839430 Received: from mail-wm1-f69.google.com (mail-wm1-f69.google.com [209.85.128.69]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-361-vnhZGts8Pfm1f244hgnA2w-1; Thu, 31 Mar 2022 17:04:57 -0400 X-MC-Unique: vnhZGts8Pfm1f244hgnA2w-1 Received: by mail-wm1-f69.google.com with SMTP id z16-20020a05600c0a1000b0038bebbd8548so1877637wmp.3 for ; Thu, 31 Mar 2022 14:04:56 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=rT5EtuR8CSHEywBpYsEGxV+PVUCu9Vva42XM3/y0R14=; b=CuqkQdY9Q59dprV2z8HwqlIurRqNg79ku9pQsrJx6nGoAA7R425E4loPWej+a3hyKS hch8cN4U67imRQR5w/zkhA78XY2Oto4Iox9bBpEf06iK8wzBsS4rjHEARsUC8ggDqEH3 F5ZGKnkmh5nRL81XHnGRFIWzBeGCvO7uUXfy5DDcWCEAi4S08XChVrWMjKU1Qa5Fb6XX RXCASDTPDcitsVgESYzeZf34Al4DToFMv8oOdH/5Wos6bDe0B8LLgXxCLD0x+AKTmhgN zti2QIVRvcsOWyX9vcsQg675muAyKbuiAizH+N05tlFr3CFaW543cykBFfwAioQ3ONUw 5aHg== X-Gm-Message-State: AOAM532riLe+8EdTXmDxrsYPV18XIv1Op20wcrUhT1zBZyvo8sVMdX82 WYNeDJoRSztstkTuKdg7vOwA9Nuos/REhWobVduurVY42Z9Y0dpDBD4kPdZFRGfihhQfPsdkRdN HZDf1NtA/eodfgAWRqac1o/GsyXQzzWdt+Hx7NGIE4D7OpIeJkwnHRoqUmSpTg8CzqR6FJ1EkGA == X-Received: by 2002:a5d:47c1:0:b0:204:1797:2c98 with SMTP id o1-20020a5d47c1000000b0020417972c98mr5538383wrc.502.1648760695390; Thu, 31 Mar 2022 14:04:55 -0700 (PDT) X-Google-Smtp-Source: ABdhPJxH+NCkJ6AS/6ZkeDFUiNiUxb3FMwwY5cqqpqkbTRuclh06pxWZl6M2WjmuUCPgMOhcJHjysw== X-Received: by 2002:a5d:47c1:0:b0:204:1797:2c98 with SMTP id o1-20020a5d47c1000000b0020417972c98mr5538369wrc.502.1648760695101; Thu, 31 Mar 2022 14:04:55 -0700 (PDT) Received: from localhost (host86-169-131-113.range86-169.btcentralplus.com. [86.169.131.113]) by smtp.gmail.com with ESMTPSA id r13-20020adfbb0d000000b00203e0efdd3bsm396504wrg.107.2022.03.31.14.04.53 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 31 Mar 2022 14:04:54 -0700 (PDT) To: gdb-patches@sourceware.org Subject: [PATCH 16/16] gdb: update comments throughout reggroups.{c,h} files Date: Thu, 31 Mar 2022 22:04:22 +0100 Message-Id: <5c4a9642f0e6a0ec78b2a6c13e5fdbf6762614a5.1648760270.git.aburgess@redhat.com> X-Mailer: git-send-email 2.25.4 In-Reply-To: References: MIME-Version: 1.0 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: 8bit Content-Type: text/plain; charset="US-ASCII"; x-default=true X-BeenThere: gdb-patches@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Gdb-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , From: Andrew Burgess via Gdb-patches Reply-To: Andrew Burgess Cc: Andrew Burgess Errors-To: gdb-patches-bounces+public-inbox=simark.ca@sourceware.org Sender: "Gdb-patches" 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.c | 11 +++++++++-- gdb/reggroups.h | 14 ++++++++++++-- 2 files changed, 21 insertions(+), 4 deletions(-) diff --git a/gdb/reggroups.c b/gdb/reggroups.c index 96d4ae4d1f8..ef5e47e0986 100644 --- a/gdb/reggroups.c +++ b/gdb/reggroups.c @@ -28,6 +28,8 @@ #include "gdbcmd.h" /* For maintenanceprintlist. */ #include "gdbsupport/gdb_obstack.h" +/* See reggroups.h. */ + const reggroup * reggroup_new (const char *name, enum reggroup_type type) { @@ -82,9 +84,11 @@ struct reggroups std::vector m_groups; }; +/* Key used to lookup register group data from a gdbarch. */ + static struct gdbarch_data *reggroups_data; -/* Add GROUP to the list of register groups for GDBARCH. */ +/* See reggroups.h. */ void reggroup_add (struct gdbarch *gdbarch, const reggroup *group) @@ -128,7 +132,8 @@ gdbarch_reggroups (struct gdbarch *gdbarch) return groups->groups (); } -/* Is REGNUM a member of REGGROUP? */ +/* See reggroups.h. */ + int default_register_reggroup_p (struct gdbarch *gdbarch, int regnum, const struct reggroup *group) @@ -207,6 +212,8 @@ reggroups_dump (struct gdbarch *gdbarch, struct ui_file *file) } } +/* Implement 'maintenance print reggroups' command. */ + static void maintenance_print_reggroups (const char *args, int from_tty) { diff --git a/gdb/reggroups.h b/gdb/reggroups.h index db5625a53bd..8aa9ad8c76f 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 a 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. */ -- 2.25.4