From 482be383b72bacfff81032a6f8979ec5ec9aac4d Mon Sep 17 00:00:00 2001
From: Andrew Ash <aash@palantir.com>
Date: Wed, 28 Aug 2024 22:28:34 -0700
Subject: [PATCH 1/4] Deprecate CaffeineCacheStats.registerCache

---
 .../palantir/tritium/metrics/caffeine/CaffeineCacheStats.java | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/tritium-caffeine/src/main/java/com/palantir/tritium/metrics/caffeine/CaffeineCacheStats.java b/tritium-caffeine/src/main/java/com/palantir/tritium/metrics/caffeine/CaffeineCacheStats.java
index 6cdf205f..5eeb4118 100644
--- a/tritium-caffeine/src/main/java/com/palantir/tritium/metrics/caffeine/CaffeineCacheStats.java
+++ b/tritium-caffeine/src/main/java/com/palantir/tritium/metrics/caffeine/CaffeineCacheStats.java
@@ -78,9 +78,9 @@ public static void registerCache(MetricRegistry registry, Cache<?, ?> cache, Str
      * @param cache cache to instrument
      * @param name cache name
      * <p>
-     * Soon to be deprecated, prefer {@link Caffeine#recordStats(Supplier)} and {@link CacheStats#of(TaggedMetricRegistry, String)}
+     * @deprecated Prefer {@link Caffeine#recordStats(Supplier)} and {@link CacheStats#of(TaggedMetricRegistry, String)}
      */
-    // Soon to be @Deprecated
+    @Deprecated
     public static void registerCache(TaggedMetricRegistry registry, Cache<?, ?> cache, @Safe String name) {
         checkNotNull(registry, "registry");
         checkNotNull(cache, "cache");

From 6790cc8df9aff3b13e0000588f1eb276314d59ff Mon Sep 17 00:00:00 2001
From: svc-changelog <svc-changelog@palantir.com>
Date: Thu, 29 Aug 2024 05:34:49 +0000
Subject: [PATCH 2/4] Add generated changelog entries

---
 changelog/@unreleased/pr-2003.v2.yml | 5 +++++
 1 file changed, 5 insertions(+)
 create mode 100644 changelog/@unreleased/pr-2003.v2.yml

diff --git a/changelog/@unreleased/pr-2003.v2.yml b/changelog/@unreleased/pr-2003.v2.yml
new file mode 100644
index 00000000..2488e26c
--- /dev/null
+++ b/changelog/@unreleased/pr-2003.v2.yml
@@ -0,0 +1,5 @@
+type: improvement
+improvement:
+  description: Deprecate CaffeineCacheStats.registerCache
+  links:
+  - https://github.com/palantir/tritium/pull/2003

From b8101697c36c09fbb91cc4a79490c65000026fc5 Mon Sep 17 00:00:00 2001
From: Andrew Ash <andrew@andrewash.com>
Date: Thu, 29 Aug 2024 11:01:53 -0700
Subject: [PATCH 3/4] Update
 tritium-caffeine/src/main/java/com/palantir/tritium/metrics/caffeine/CaffeineCacheStats.java

Co-authored-by: David Schlosnagle <davids@palantir.com>
---
 .../palantir/tritium/metrics/caffeine/CaffeineCacheStats.java | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/tritium-caffeine/src/main/java/com/palantir/tritium/metrics/caffeine/CaffeineCacheStats.java b/tritium-caffeine/src/main/java/com/palantir/tritium/metrics/caffeine/CaffeineCacheStats.java
index 5eeb4118..e11aee4c 100644
--- a/tritium-caffeine/src/main/java/com/palantir/tritium/metrics/caffeine/CaffeineCacheStats.java
+++ b/tritium-caffeine/src/main/java/com/palantir/tritium/metrics/caffeine/CaffeineCacheStats.java
@@ -78,7 +78,9 @@ public static void registerCache(MetricRegistry registry, Cache<?, ?> cache, Str
      * @param cache cache to instrument
      * @param name cache name
      * <p>
-     * @deprecated Prefer {@link Caffeine#recordStats(Supplier)} and {@link CacheStats#of(TaggedMetricRegistry, String)}
+     * @deprecated Prefer {@link CacheStats#of(TaggedMetricRegistry, String)}.{@link CacheStats#register(Function) register(stats ->) {@link Caffeine#recordStats(Supplier) Caffeine.newBuilder().recordStats(stats)}...  
+     * <p/>
+     * See <a href="https://github.com/palantir/tritium?tab=readme-ov-file#instrumenting-a-caffeine-cache">Instrumenting a [Caffeine cache](https://github.com/ben-manes/caffeine/)</a>
      */
     @Deprecated
     public static void registerCache(TaggedMetricRegistry registry, Cache<?, ?> cache, @Safe String name) {

From eb7ef14679461e0625143a230d79733f85f2d562 Mon Sep 17 00:00:00 2001
From: Andrew Ash <aash@palantir.com>
Date: Thu, 29 Aug 2024 11:08:58 -0700
Subject: [PATCH 4/4] fix formatting

---
 .../palantir/tritium/metrics/caffeine/CaffeineCacheStats.java   | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tritium-caffeine/src/main/java/com/palantir/tritium/metrics/caffeine/CaffeineCacheStats.java b/tritium-caffeine/src/main/java/com/palantir/tritium/metrics/caffeine/CaffeineCacheStats.java
index e11aee4c..fccbfe4e 100644
--- a/tritium-caffeine/src/main/java/com/palantir/tritium/metrics/caffeine/CaffeineCacheStats.java
+++ b/tritium-caffeine/src/main/java/com/palantir/tritium/metrics/caffeine/CaffeineCacheStats.java
@@ -78,7 +78,7 @@ public static void registerCache(MetricRegistry registry, Cache<?, ?> cache, Str
      * @param cache cache to instrument
      * @param name cache name
      * <p>
-     * @deprecated Prefer {@link CacheStats#of(TaggedMetricRegistry, String)}.{@link CacheStats#register(Function) register(stats ->) {@link Caffeine#recordStats(Supplier) Caffeine.newBuilder().recordStats(stats)}...  
+     * @deprecated Prefer {@link CacheStats#of(TaggedMetricRegistry, String)}.{@link CacheStats#register(Function) register(stats ->} {@link Caffeine#recordStats(Supplier) Caffeine.newBuilder().recordStats(stats)}}...
      * <p/>
      * See <a href="https://github.com/palantir/tritium?tab=readme-ov-file#instrumenting-a-caffeine-cache">Instrumenting a [Caffeine cache](https://github.com/ben-manes/caffeine/)</a>
      */