From 4e3bf65865ecd8aa6e26f3c36d8cccbca25be07f Mon Sep 17 00:00:00 2001
From: Sean Gilligan <sean@msgilligan.com>
Date: Tue, 9 Aug 2022 19:41:37 -0700
Subject: [PATCH] base/package-info.java: add the "deprecation exception" rule
 to package comment

---
 core/src/main/java/org/bitcoinj/base/package-info.java | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/core/src/main/java/org/bitcoinj/base/package-info.java b/core/src/main/java/org/bitcoinj/base/package-info.java
index 5785984d0..0c1119da3 100644
--- a/core/src/main/java/org/bitcoinj/base/package-info.java
+++ b/core/src/main/java/org/bitcoinj/base/package-info.java
@@ -22,6 +22,13 @@
  *     <li>No API dependencies on external libraries other than the core JDK</li>
  *     <li>Implementation dependencies on Guava are allowed for now (but should be avoided as much as possible)</li>
  * </ul>
+ * <p>
+ * <b>Temporary exception:</b> In the 0.17 release, we are allowing some dependencies on other packages, e.g. to
+ * {@link org.bitcoinj.core.NetworkParameters} provided that those references are in <b>deprecated</b> methods. This will
+ * smooth migration by allowing users to, for example, replace {@code import org.bitcoinj.base.Address} with
+ * {@code import org.bitcoinj.core.Address} as first step of conversion and remove usages of the deprecated methods in
+ * a second step.
+ * <p>
  * The base package will help us make bitcoinj more modular as we will use it to break circular dependencies
  * between existing packages. We are also considering splitting {@code base} into a separate JAR/module in a
  * future release.