From: Jason Merrill <jason@redhat.com>
Date: Fri, 8 Sep 2023 15:27:26 +0000 (-0400)
Subject: doc: GTY((cache)) documentation tweak
X-Git-Tag: basepoints/gcc-15~6054
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=93996cfb308ffc633a23d0f1b72bcdc086bed864;p=thirdparty%2Fgcc.git

doc: GTY((cache)) documentation tweak

gcc/ChangeLog:

	* doc/gty.texi: Add discussion of cache vs. deletable.
---

diff --git a/gcc/doc/gty.texi b/gcc/doc/gty.texi
index 15f9fa07405b..1dfe46526441 100644
--- a/gcc/doc/gty.texi
+++ b/gcc/doc/gty.texi
@@ -306,6 +306,13 @@ called on that variable between the mark and sweep phases of garbage
 collection.  The gt_clear_cache function is free to mark blocks as used, or to
 clear pointers in the variable.
 
+In a hash table, the @samp{gt_cleare_cache} function discards entries
+if the key is not marked, or marks the value if the key is marked.
+
+Note that caches should generally use @code{deletable} instead;
+@code{cache} is only preferable if the value is impractical to
+recompute from the key when needed.
+
 @findex deletable
 @item deletable