Skip to content

Conversation

@AlexandreSinger
Copy link
Collaborator

@AlexandreSinger AlexandreSinger commented Dec 11, 2025

Based on feedback from different people, removed some flags which go mostly unused and would require a lot of effort to support.

This includes the -through option for set_false_path and set_min/max_delay. This option can always be added back if deemed needed later.

Summary by CodeRabbit

  • Documentation
    • Updated syntax documentation to reflect removal of optional flags from create_generated_clock, set_false_path, set_max_delay, and set_min_delay commands.
    • Command examples updated to reflect current supported options.

✏️ Tip: You can customize this high-level summary in your review settings.

Based on feedback from different people, removed some flags which go
mostly unused and would require a lot of effort to support.

This includes the `-through` option for set_false_path and
set_min/max_delay. This option can always be added back if deemed needed
later.
@coderabbitai
Copy link

coderabbitai bot commented Dec 11, 2025

Walkthrough

Documentation updates that remove optional flags from SDC command syntax in docs/syntax/README.md. Specifically, the -master_clock option is removed from create_generated_clock, and the -through option is removed from set_false_path, set_max_delay, and set_min_delay commands.

Changes

Cohort / File(s) Summary
SDC Command Documentation
docs/syntax/README.md
Removed optional flags: -master_clock from create_generated_clock; -through from set_false_path, set_max_delay, and set_min_delay. Examples and option listings updated accordingly.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Documentation-only changes with straightforward flag removals
  • No logic, code, or functional behavior alterations
  • Clear, repetitive edits across command descriptions

Possibly related PRs

  • [Docs] Added Syntax Coverage Draft #21: Adds SDC command syntax documentation entries for create_generated_clock, set_false_path, set_max_delay, and set_min_delay—directly related to the flags being removed in this PR's documentation updates.
  • Verilog Syntax Issues Resolved #20: Updates SDC generator implementation for create/change_clock handling and validation of from/through/to option mutual-exclusivity—aligns with the removal of -through option documentation.

Poem

🐰 A hop through the docs, flags all in a line,
We tidied and trimmed, made the syntax so fine,
Out goes the clutter, the options unclear,
Cleaner command definitions are finally here! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: removing optional flags from documentation based on feedback, which aligns with the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feature-docs

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4274132 and 3f0a256.

📒 Files selected for processing (1)
  • docs/syntax/README.md (0 hunks)
💤 Files with no reviewable changes (1)
  • docs/syntax/README.md

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@AlexandreSinger
Copy link
Collaborator Author

@Minchan-Kwon FYI.

Note: three commands are still under review by a few people. Lets assume that we will support them, but I will keep you posted:

  • set_clock_groups
  • set_clock_latency
  • set_disable_timing

@AlexandreSinger AlexandreSinger merged commit 1041d08 into master Dec 11, 2025
4 checks passed
@AlexandreSinger AlexandreSinger deleted the feature-docs branch December 11, 2025 21:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants