From: Jacob Lifshay <programmerjake@gmail.com>
Date: Fri, 26 Aug 2022 17:10:36 +0000 (-0700)
Subject: add note that migration to new PLRU should be blocked on #913
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=f9f3b51ae0d28314fa0ac827a294b78adc0d003b;p=nmutil.git

add note that migration to new PLRU should be blocked on #913

https://bugs.libre-soc.org/show_bug.cgi?id=913
---

diff --git a/src/nmutil/plru2.py b/src/nmutil/plru2.py
index d766f6c..187a7b4 100644
--- a/src/nmutil/plru2.py
+++ b/src/nmutil/plru2.py
@@ -3,6 +3,8 @@
 
 # new PLRU API, once all users have migrated to new API in plru2.py, then
 # plru2.py will be renamed to plru.py.
+# IMPORTANT: since the API will change more, migration should be blocked on:
+# https://bugs.libre-soc.org/show_bug.cgi?id=913
 
 from nmigen.hdl.ir import Elaboratable, Display, Signal, Array, Const, Value
 from nmigen.hdl.dsl import Module
@@ -13,6 +15,9 @@ from nmigen.lib.coding import Decoder
 class PLRU(Elaboratable):
     r""" PLRU - Pseudo Least Recently Used Replacement
 
+        IMPORTANT: since the API will change more, migration should be blocked on:
+        https://bugs.libre-soc.org/show_bug.cgi?id=913
+
         PLRU-tree indexing:
         lvl0        0
                    / \
@@ -28,6 +33,9 @@ class PLRU(Elaboratable):
     def __init__(self, log2_num_ways, debug=False):
         # type: (int, bool) -> None
         """
+        IMPORTANT: since the API will change more, migration should be blocked on:
+        https://bugs.libre-soc.org/show_bug.cgi?id=913
+
         Arguments:
         log2_num_ways: int
             the log-base-2 of the number of cache ways -- BITS in plru.vhdl