From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: by sourceware.org (Postfix, from userid 2126) id 9BED13857367; Sat, 16 Apr 2022 19:59:55 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 9BED13857367 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable From: Tom Tromey To: gdb-cvs@sourceware.org Subject: [binutils-gdb] Add comments to dwarf2/abbrev-cache.h X-Act-Checkin: binutils-gdb X-Git-Author: Tom Tromey X-Git-Refname: refs/heads/master X-Git-Oldrev: 3beda815bdd784aa51255fab86dd505dae460bd1 X-Git-Newrev: 3c8184c43d179e03473805f4f82cbbb3eba751f4 Message-Id: <20220416195955.9BED13857367@sourceware.org> Date: Sat, 16 Apr 2022 19:59:55 +0000 (GMT) X-BeenThere: gdb-cvs@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Gdb-cvs mailing list List-Unsubscribe: , List-Archive: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 16 Apr 2022 19:59:55 -0000 https://sourceware.org/git/gitweb.cgi?p=3Dbinutils-gdb.git;h=3D3c8184c43d17= 9e03473805f4f82cbbb3eba751f4 commit 3c8184c43d179e03473805f4f82cbbb3eba751f4 Author: Tom Tromey Date: Sat Apr 16 13:58:34 2022 -0600 Add comments to dwarf2/abbrev-cache.h =20 This patch started when I noticed that the unordered_set include wasn't needed in abbrev-cache.h. (That was probably leftover from some earlier implementation of the class.) Then, I noticed that the class itself was under-commented. This patch fixes both issues. Diff: --- gdb/dwarf2/abbrev-cache.h | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/gdb/dwarf2/abbrev-cache.h b/gdb/dwarf2/abbrev-cache.h index 7af28cd8181..d729eb9dd1b 100644 --- a/gdb/dwarf2/abbrev-cache.h +++ b/gdb/dwarf2/abbrev-cache.h @@ -21,15 +21,18 @@ #define GDB_DWARF2_ABBREV_CACHE_H =20 #include "dwarf2/abbrev.h" -#include #include "gdbtypes.h" =20 +/* An abbrev cache holds abbrev tables for easier reuse. */ class abbrev_cache { public: abbrev_cache (); DISABLE_COPY_AND_ASSIGN (abbrev_cache); =20 + /* Find an abbrev table coming from the abbrev section SECTION at + offset OFFSET. Return the table, or nullptr if it has not yet + been registered. */ abbrev_table *find (struct dwarf2_section_info *section, sect_offset off= set) { search_key key =3D { section, offset }; @@ -38,6 +41,11 @@ public: to_underlying (offset)); } =20 + /* Add TABLE to this cache. Ownership of TABLE is transferred to + the cache. Note that a table at a given section+offset may only + be registered once -- a violation of this will cause an assert. + To avoid this, call the 'find' method first, to see if the table + has already been read. */ void add (abbrev_table_up table); =20 private: