From: Nick Alcock <nick.alcock@oracle.com>
Date: Tue, 1 Oct 2024 14:34:12 +0000 (+0100)
Subject: libctf: dedup: describe 'citer'
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=ac07bccf05468b089e23765e5be307054712a211;p=thirdparty%2Fbinutils-gdb.git

libctf: dedup: describe 'citer'

The distinction between the citer and citers variables in
ctf_dedup_rhash_type is somewhat opaque (it's a micro-optimization to avoid
having to allocate entire sets when we know in advance that we'll only have
to store one value).  Add a comment.

libctf/
	* ctf-dedup.c (ctf_dedup_rhash_type): Comment on citers variables.
---

diff --git a/libctf/ctf-dedup.c b/libctf/ctf-dedup.c
index 486b0efa8c2..1e876c8a9e0 100644
--- a/libctf/ctf-dedup.c
+++ b/libctf/ctf-dedup.c
@@ -582,6 +582,8 @@ ctf_dedup_rhash_type (ctf_dict_t *fp, ctf_dict_t *input, ctf_dict_t **inputs,
   const char *whaterr;
   int err = 0;
 
+  /* "citer" is for types that reference only one other type: "citers" can store
+     many of them, but is more expensive to both populate and traverse.  */
   const char *citer = NULL;
   ctf_dynset_t *citers = NULL;