search

The-OpenROAD-Project / OpenROAD-flow-scripts

OpenROAD's scripts implementing an RTL-to-GDS Flow. Documentation at https://openroad-flow-scripts.readthedocs.io/en/latest/
https://theopenroadproject.org/
Other
342 stars 289 forks source link

Make it easier to figure out mapping from OpenROAD commands and options to ORFS variables and vice versa #2570

Closed oharboe closed 1 day ago

oharboe commented 1 day ago

Description

Curretnly, the only way to figure out what ORFS variables affect which OpenROAD commands and options and vice versa is to carefully read scripts/*.tcl files.

There's generally little help from the naming convention in ORFS variables. Even with something like PLACE_DENSITY it is very hard to connect the dots from this variable name to how they are actually used by OpenROAD commands and options.

This current state of affairs makes readability of the scripts/*.tcl files for the user valuable.

Suggested Solution

Unsure what to suggest...

Additional Context

No response

maliberty commented 1 day ago

I don't know what naming convention would be reasonable as variables may be used in multiple places. I don't know that the average user needs to know which stages they are used in. It seems to be more of a flow maintainer question and I expect such people will have a lot more familiarity.

maliberty commented 1 day ago

Please reopen if there is something actionable.