From a3255fd8d31f44b4000a35d5a9b9d895c1620950 Mon Sep 17 00:00:00 2001 From: Krystine Sherwin <93062060+KrystalDelusion@users.noreply.github.com> Date: Sat, 13 Jan 2024 16:57:10 +1300 Subject: [PATCH] Docs: opt_rmunused -> opt_clean --- docs/source/yosys_internals/formats/rtlil_rep.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/source/yosys_internals/formats/rtlil_rep.rst b/docs/source/yosys_internals/formats/rtlil_rep.rst index ce373ce6c..5de3430f2 100644 --- a/docs/source/yosys_internals/formats/rtlil_rep.rst +++ b/docs/source/yosys_internals/formats/rtlil_rep.rst @@ -74,13 +74,13 @@ This has three advantages: - First, it is impossible that an auto-generated identifier collides with an identifier that was provided by the user. -.. TODO:: ``opt_clean`` (or clean), also ``-purge`` - - Second, the information about which identifiers were originally provided by the user is always available which can help guide some optimizations. For - example the ``opt_rmunused`` tries to preserve signals with a user-provided + example, :cmd:ref:`opt_clean` tries to preserve signals with a user-provided name but doesn't hesitate to delete signals that have auto-generated names - when they just duplicate other signals. + when they just duplicate other signals. Note that this can be overridden + with the `-purge` option to also delete internal nets with user-provided + names. - Third, the delicate job of finding suitable auto-generated public visible names is deferred to one central location. Internally auto-generated names