sim_if/ghdl: remove 'ghdl.flags' (#932)

Author: umarcor

docs/news.d/932.breaking.rst

@@ -0,0 +1,2 @@
+[GHDL] Remove ``ghdl.flags``; use ``ghdl.a_flags`` instead.
+

docs/py/opts.rst

@@ -11,9 +11,6 @@ The following compilation options are known.
    Extra arguments passed to ``ghdl -a`` command during compilation.
    Must be a list of strings.
 
-``ghdl.flags``
-  Deprecated alias of ``ghdl.a_flags``. It will be removed in future releases.
-
 ``incisive.irun_vhdl_flags``
    Extra arguments passed to the Incisive ``irun`` command when compiling VHDL files.
    Must be a list of strings.

examples/vhdl/array/run.py

@@ -26,7 +26,7 @@
 
 VU.add_library("lib").add_source_files([SRC_PATH / "*.vhd", SRC_PATH / "test" / "*.vhd"])
 
-VU.set_compile_option("ghdl.flags", ["-frelaxed"])
+VU.set_compile_option("ghdl.a_flags", ["-frelaxed"])
 VU.set_sim_option("ghdl.elab_flags", ["-frelaxed"])
 
 VU.set_compile_option("nvc.a_flags", ["--relaxed"])

tests/unit/test_ghdl_interface.py

@@ -204,7 +204,7 @@ def test_compile_project_extra_flags(self, check_output):
         project = Project()
         project.add_library("lib", "lib_path")
         source_file = project.add_source_file("file.vhd", "lib", file_type="vhdl")
-        source_file.set_compile_option("ghdl.flags", ["custom", "flags"])
+        source_file.set_compile_option("ghdl.a_flags", ["custom", "flags"])
         simif.compile_project(project)
         check_output.assert_called_once_with(
             [

tests/unit/test_project.py

@@ -970,7 +970,7 @@ def test_should_recompile_files_after_changing_compile_options(self):
         self.update(file3)
         self.assert_should_recompile([])
 
-        file2.set_compile_option("ghdl.flags", ["--no-vital-checks"])
+        file2.set_compile_option("ghdl.a_flags", ["--no-vital-checks"])
         self.assert_should_recompile([file2, file3])
 
     def test_should_recompile_files_after_changing_vhdl_standard(self):
@@ -991,37 +991,37 @@ def test_should_recompile_files_after_changing_vhdl_standard(self):
     def test_add_compile_option(self):
         self.project.add_library("lib", "lib_path")
         file1 = self.add_source_file("lib", "file.vhd", "")
-        file1.add_compile_option("ghdl.flags", ["--foo"])
-        self.assertEqual(file1.get_compile_option("ghdl.flags"), ["--foo"])
-        file1.add_compile_option("ghdl.flags", ["--bar"])
-        self.assertEqual(file1.get_compile_option("ghdl.flags"), ["--foo", "--bar"])
-        file1.set_compile_option("ghdl.flags", ["--xyz"])
-        self.assertEqual(file1.get_compile_option("ghdl.flags"), ["--xyz"])
+        file1.add_compile_option("ghdl.a_flags", ["--foo"])
+        self.assertEqual(file1.get_compile_option("ghdl.a_flags"), ["--foo"])
+        file1.add_compile_option("ghdl.a_flags", ["--bar"])
+        self.assertEqual(file1.get_compile_option("ghdl.a_flags"), ["--foo", "--bar"])
+        file1.set_compile_option("ghdl.a_flags", ["--xyz"])
+        self.assertEqual(file1.get_compile_option("ghdl.a_flags"), ["--xyz"])
 
     def test_add_compile_option_does_not_mutate_argument(self):
         self.project.add_library("lib", "lib_path")
         file1 = self.add_source_file("lib", "file.vhd", "")
         options = ["--foo"]
-        file1.add_compile_option("ghdl.flags", options)
+        file1.add_compile_option("ghdl.a_flags", options)
         options[0] = "--xyz"
-        self.assertEqual(file1.get_compile_option("ghdl.flags"), ["--foo"])
-        file1.add_compile_option("ghdl.flags", ["--bar"])
+        self.assertEqual(file1.get_compile_option("ghdl.a_flags"), ["--foo"])
+        file1.add_compile_option("ghdl.a_flags", ["--bar"])
         self.assertEqual(options, ["--xyz"])
 
     def test_set_compile_option_does_not_mutate_argument(self):
         self.project.add_library("lib", "lib_path")
         file1 = self.add_source_file("lib", "file.vhd", "")
         options = ["--foo"]
-        file1.set_compile_option("ghdl.flags", options)
+        file1.set_compile_option("ghdl.a_flags", options)
         options[0] = "--xyz"
-        self.assertEqual(file1.get_compile_option("ghdl.flags"), ["--foo"])
+        self.assertEqual(file1.get_compile_option("ghdl.a_flags"), ["--foo"])
 
     def test_compile_option_validation(self):
         self.project.add_library("lib", "lib_path")
         source_file = self.add_source_file("lib", "file.vhd", "")
         self.assertRaises(ValueError, source_file.set_compile_option, "foo", None)
-        self.assertRaises(ValueError, source_file.set_compile_option, "ghdl.flags", None)
-        self.assertRaises(ValueError, source_file.add_compile_option, "ghdl.flags", None)
+        self.assertRaises(ValueError, source_file.set_compile_option, "ghdl.a_flags", None)
+        self.assertRaises(ValueError, source_file.add_compile_option, "ghdl.a_flags", None)
         self.assertRaises(ValueError, source_file.get_compile_option, "foo")
 
     def test_should_recompile_files_affected_by_change_with_later_timestamp(self):

tests/unit/test_ui.py

@@ -925,17 +925,17 @@ def test_compile_options(self):
 
         # Use methods on all types of interface objects
         for obj in [source_file, ui, lib, lib.get_source_files(file_name), ui.get_libraries("lib")]:
-            obj.set_compile_option("ghdl.flags", [])
-            self.assertEqual(source_file.get_compile_option("ghdl.flags"), [])
+            obj.set_compile_option("ghdl.a_flags", [])
+            self.assertEqual(source_file.get_compile_option("ghdl.a_flags"), [])
 
-            obj.add_compile_option("ghdl.flags", ["1"])
-            self.assertEqual(source_file.get_compile_option("ghdl.flags"), ["1"])
+            obj.add_compile_option("ghdl.a_flags", ["1"])
+            self.assertEqual(source_file.get_compile_option("ghdl.a_flags"), ["1"])
 
-            obj.add_compile_option("ghdl.flags", ["2"])
-            self.assertEqual(source_file.get_compile_option("ghdl.flags"), ["1", "2"])
+            obj.add_compile_option("ghdl.a_flags", ["2"])
+            self.assertEqual(source_file.get_compile_option("ghdl.a_flags"), ["1", "2"])
 
-            obj.set_compile_option("ghdl.flags", ["3"])
-            self.assertEqual(source_file.get_compile_option("ghdl.flags"), ["3"])
+            obj.set_compile_option("ghdl.a_flags", ["3"])
+            self.assertEqual(source_file.get_compile_option("ghdl.a_flags"), ["3"])
 
     def test_default_vhdl_standard_is_used(self):
         file_name = "foo.vhd"

vunit/sim_if/ghdl.py

@@ -17,7 +17,6 @@
 import shutil
 from json import dump
 from sys import stdout  # To avoid output catched in non-verbose mode
-from warnings import warn
 from ..exceptions import CompileError
 from ..ostools import Process
 from . import SimulatorInterface, ListOfStringOption, StringOption, BooleanOption
@@ -38,7 +37,7 @@ class GHDLInterface(SimulatorInterface):  # pylint: disable=too-many-instance-at
 
     compile_options = [
         ListOfStringOption("ghdl.a_flags"),
-        ListOfStringOption("ghdl.flags"),
+        ListOfStringOption("ghdl.flags"),  # Removed in v5.0.0
     ]
 
     sim_options = [
@@ -237,6 +236,9 @@ def compile_vhdl_file_command(self, source_file):
         """
         Returns the command to compile a vhdl file
         """
+        if source_file.compile_options.get("ghdl.flags", []) != []:
+            raise RuntimeError("'ghdl.flags was removed in v5.0.0; use 'ghdl.a_flags' instead")
+
         cmd = [
             str(Path(self._prefix) / self.executable),
             "-a",
@@ -247,16 +249,7 @@ def compile_vhdl_file_command(self, source_file):
         for library in self._project.get_libraries():
             cmd += [f"-P{library.directory!s}"]
 
-        a_flags = source_file.compile_options.get("ghdl.a_flags", [])
-        flags = source_file.compile_options.get("ghdl.flags", [])
-        if flags != []:
-            warn(
-                ("'ghdl.flags' is deprecated and it will be removed in future releases; use 'ghdl.a_flags' instead"),
-                Warning,
-            )
-            a_flags += flags
-
-        cmd += a_flags
+        cmd += source_file.compile_options.get("ghdl.a_flags", [])
 
         if source_file.compile_options.get("enable_coverage", False):
             # Add gcc compilation flags for coverage