3
0
Fork 0
mirror of https://github.com/YosysHQ/yosys synced 2025-04-13 04:28:18 +00:00

Docs: opt_rmunused -> opt_clean

This commit is contained in:
Krystine Sherwin 2024-01-13 16:57:10 +13:00
parent 064723a1cc
commit a3255fd8d3
No known key found for this signature in database

View file

@ -74,13 +74,13 @@ This has three advantages:
- First, it is impossible that an auto-generated identifier collides with an - First, it is impossible that an auto-generated identifier collides with an
identifier that was provided by the user. identifier that was provided by the user.
.. TODO:: ``opt_clean`` (or clean), also ``-purge``
- Second, the information about which identifiers were originally provided by - Second, the information about which identifiers were originally provided by
the user is always available which can help guide some optimizations. For 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 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 - Third, the delicate job of finding suitable auto-generated public visible
names is deferred to one central location. Internally auto-generated names names is deferred to one central location. Internally auto-generated names