Skip to content

docs: fix option names in rsz and cts READMEs - #12399

Closed
xia-chao wants to merge 1 commit into
The-OpenROAD-Project:masterfrom
xia-chao:docs-option-names
Closed

xia-chao wants to merge 1 commit into
The-OpenROAD-Project:masterfrom
xia-chao:docs-option-names

Conversation

@xia-chao

@xia-chao xia-chao commented Nov 20, 2026 •

Copy link
Copy Markdown
Contributor

Summary

The rsz and cts READMEs listed option names that the commands do not accept. They now match the names the commands parse.

Type of Change

  • Documentation

Impact

Readers copying the option tables no longer hit an unknown-keyword error.

Verification

  • I have verified that the local build succeeds (./etc/Build.sh).
  • I have run the relevant tests and they pass.
  • My code follows the repository's formatting guidelines.
  • I have included tests to prevent regressions.
  • I have signed my commits (DCO).

Related Issues

None.

The READMEs listed option names that the commands do not accept, and a
`-verbose` option that eliminate_dead_logic does not have.

Signed-off-by: Xia Chao <shapirolutts@gmail.com>
@xia-chao
xia-chao requested review from a team as code owners November 20, 2026 10:13

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the documentation in openroad/cts/README.md and openroad/rsz/README.md to align with command option changes. Specifically, it renames the '-root_buffer' option to '-root_buf' in the CTS documentation, updates the '-skip_size_down_fanout' option to '-skip_size_down' in the Resizer documentation, and removes the deprecated '-verbose' option documentation from the 'eliminate_dead_logic' command. There are no review comments to evaluate, and I have no additional feedback to provide.

@xia-chao xia-chao closed this Nov 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant