Add initial logging rework deprecation warnings to docs. #168

SystemRDL · Apr 21, 2023 · 0b7eeec · 0b7eeec
1 parent 37496b7
commit 0b7eeec
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 0 deletions.
diff --git a/docs/api/messages.rst b/docs/api/messages.rst
@@ -44,6 +44,12 @@ Exceptions
 
 Message Handling
 ----------------
+
+.. warning::
+
+    The ``MessagePrinter`` and ``MessageHandler`` classes will be deprecated in
+    a future release. See the following page for details: https://github.com/SystemRDL/systemrdl-compiler/issues/168
+
 .. autoclass:: systemrdl.messages.MessagePrinter
     :members:
 

diff --git a/systemrdl/compiler.py b/systemrdl/compiler.py
@@ -104,6 +104,10 @@ def __init__(self, **kwargs: Any):
             raise TypeError("got an unexpected keyword argument '%s'" % list(kwargs.keys())[0])
 
         #: Reference to the compiler's :class:`~systemrdl.messages.MessageHandler` object
+        #:
+        #: .. warning::
+        #:
+        #:      This will be deprecated in a future release. See this page for more details: https://github.com/SystemRDL/systemrdl-compiler/issues/168
         self.msg = self.env.msg
 
         self.namespace = NamespaceRegistry(self.env) # type: NamespaceRegistry

diff --git a/systemrdl/importer.py b/systemrdl/importer.py
@@ -25,6 +25,10 @@ def __init__(self, compiler: RDLCompiler):
         self.compiler = compiler
 
         #: Reference to the compiler message handler
+        #:
+        #: .. warning::
+        #:
+        #:      This will be deprecated in a future release. See this page for more details: https://github.com/SystemRDL/systemrdl-compiler/issues/168
         self.msg = compiler.env.msg
 
         #: Source reference used by default when not specified in importer