The-OpenROAD-Project / The-OpenROAD-Project/OpenSTA
Inconsistent documentation of -source argument to create_generated_clock.
Nobody has claimed this yet.
- Dominant language
- Verilog
- Stars
- 619
- Forks
- 270
- Avg merge
- 5d 15h
- Merged PRs (30d)
- 4
Description
The API listing for create_generated_clock says -source is a pin:
The examples show it being used with a clock instead (which is what I'm more used to from other tools):
Which is correct? Experimentally, passing a clock seems to raise an error saying the clock is not a pin.
# Primary input clock. Source of all other clocks except for DCK.
create_clock [get_pins i_chip_core.clocks_u.clkroot_padin_clk_u.magic_clkroot_anchor_u/Z] \
-name padin_clk \
-period $PADIN_CLK_PERIOD
create_generated_clock [get_pins i_chip_core.clocks_u.clkroot_sys_u.magic_clkroot_anchor_u/Z] \
-name clk_sys \
-source padin_clk \
-divide_by 2
results in:
Error: chip_top.sdc line 46, pin padin_clk not found.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the create_generated_clock API listing and the examples referenced in the issue, then compare their descriptions of -source with the shown Tcl behavior. Confirm the intended argument type and update the inconsistent documentation so the listing and examples agree; done means the documented usage matches the observed command behavior.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100