Warn about deprecated Tool API implementations

Tool API backends that have already been ported to the Flow API
are marked as deprecated and will be removed in an upcoming Edalize
version.

edalize/ghdl.py

@@ -34,6 +34,9 @@ def get_doc(cls, api_ver):
             }
 
     def configure_main(self):
+        logger.warning(
+            "This backend is deprecated and will eventually be removed. Please migrate to the flow API instead.  See https://edalize.readthedocs.io/en/latest/ref/migrations.html#migrating-from-the-tool-api-to-the-flow-api for more details."
+        )
         (src_files, incdirs) = self._get_fileset_files()
         analyze_options = self.tool_options.get("analyze_options", "")
 

edalize/icarus.py

@@ -62,6 +62,9 @@ def get_doc(cls, api_ver):
             }
 
     def configure_main(self):
+        logger.warning(
+            "This backend is deprecated and will eventually be removed. Please migrate to the flow API instead.  See https://edalize.readthedocs.io/en/latest/ref/migrations.html#migrating-from-the-tool-api-to-the-flow-api for more details."
+        )
         f = open(os.path.join(self.work_root, self.name + ".scr"), "w")
 
         (src_files, incdirs) = self._get_fileset_files()

edalize/icestorm.py

@@ -2,6 +2,10 @@
 # Licensed under the 2-Clause BSD License, see LICENSE for details.
 # SPDX-License-Identifier: BSD-2-Clause
 
+import logging
+
+logger = logging.getLogger(__name__)
+
 import os.path
 
 from edalize.edatool import Edatool
@@ -48,6 +52,9 @@ def get_doc(cls, api_ver):
             }
 
     def __init__(self, edam=None, work_root=None, eda_api=None, verbose=True):
+        logger.warning(
+            "This backend is deprecated and will eventually be removed. Please migrate to the flow API instead.  See https://edalize.readthedocs.io/en/latest/ref/migrations.html#migrating-from-the-tool-api-to-the-flow-api for more details."
+        )
         super().__init__(edam, work_root, eda_api, verbose)
         _tool_opts = edam["tool_options"]["icestorm"]
 

edalize/nextpnr.py

@@ -2,6 +2,10 @@
 # Licensed under the 2-Clause BSD License, see LICENSE for details.
 # SPDX-License-Identifier: BSD-2-Clause
 
+import logging
+
+logger = logging.getLogger(__name__)
+
 import os.path
 
 from edalize.edatool import Edatool
@@ -25,6 +29,9 @@ def get_doc(cls, api_ver):
             }
 
     def configure_main(self):
+        logger.warning(
+            "This backend is deprecated and will eventually be removed. Please migrate to the flow API instead.  See https://edalize.readthedocs.io/en/latest/ref/migrations.html#migrating-from-the-tool-api-to-the-flow-api for more details."
+        )
         cst_file = ""
         lpf_file = ""
         pcf_file = ""

edalize/sandpipersaas.py

@@ -73,6 +73,9 @@ def get_doc(cls, api_ver):
             }
 
     def configure_main(self):
+        logger.warning(
+            "This backend is deprecated and will eventually be removed. Please migrate to the flow API instead.  See https://edalize.readthedocs.io/en/latest/ref/migrations.html#migrating-from-the-tool-api-to-the-flow-api for more details."
+        )
 
         if len(self.files) > 1:
             raise RuntimeError("Only 1 TL-V file is allowed")

edalize/verilator.py

@@ -134,6 +134,9 @@ def check_managed_parser(self):
             )
 
     def configure_main(self):
+        logger.warning(
+            "This backend is deprecated and will eventually be removed. Please migrate to the flow API instead.  See https://edalize.readthedocs.io/en/latest/ref/migrations.html#migrating-from-the-tool-api-to-the-flow-api for more details."
+        )
         self.check_managed_parser()
         if not self.toplevel:
             raise RuntimeError(

edalize/vivado.py

@@ -95,6 +95,9 @@ def get_doc(cls, api_ver):
             }
 
     def __init__(self, edam=None, work_root=None, eda_api=None, verbose=True):
+        logger.warning(
+            "This backend is deprecated and will eventually be removed. Please migrate to the flow API instead.  See https://edalize.readthedocs.io/en/latest/ref/migrations.html#migrating-from-the-tool-api-to-the-flow-api for more details."
+        )
         super().__init__(edam, work_root, eda_api, verbose)
         edam["flow_options"] = edam["tool_options"]["vivado"]
         self.vivado = Vivado_underlying(edam, work_root, verbose)

edalize/yosys.py

@@ -62,6 +62,9 @@ def get_doc(cls, api_ver):
             }
 
     def configure_main(self):
+        logger.warning(
+            "This backend is deprecated and will eventually be removed. Please migrate to the flow API instead.  See https://edalize.readthedocs.io/en/latest/ref/migrations.html#migrating-from-the-tool-api-to-the-flow-api for more details."
+        )
         # write Yosys tcl script file
 
         yosys_template = self.tool_options.get("yosys_template")