documentation improvement request for -min and -max

The-OpenROAD-Project / OpenSTA

OpenSTA engine

GNU General Public License v3.0

388 stars 168 forks source link

documentation improvement request for -min and -max #131

Closed mattvenn closed 1 year ago

mattvenn commented 1 year ago

in set_input_delay and set_output_delay command documentation:

-max This is the minimum arrival time. -min This is the maximum arrival time.

and from quartus docs:

-max | Applies value as maximum data required time -min | Applies value as minimum data required time

It's confusing for me as a beginner.

also would be good to:

state that it's in ns
that it's relative to before the edge
so a negative number would move it after the edge

rovinski commented 1 year ago

state that it's in ns

It actually is not in ns, it is in the time unit specified by your liberty .lib file. sky130 for example is ns, but ASAP7 is ps.

jjcherry56 commented 1 year ago

The min/max doc is definitely backwards. ALL commands use the liberty units. I added this to the opening section. The set_output_delay doc was pretty twisted so I rewrote it. Hopefully it is clearer now.

mattvenn commented 1 year ago

thanks for the fast fix on this - appreciated!

mattvenn commented 1 year ago

Couple of questions - where is the best place to ask for support for OpenSTA? I'm trying to learn to read the reports - is there an annotated report somewhere I can study?