Skip to content

Update Errors section to reference Logger instead of removed Error.hh#9673

Merged
maliberty merged 1 commit intoThe-OpenROAD-Project:masterfrom
Pinata-Consulting:fix-deprecated-error-api-ref
Mar 6, 2026
Merged

Update Errors section to reference Logger instead of removed Error.hh#9673
maliberty merged 1 commit intoThe-OpenROAD-Project:masterfrom
Pinata-Consulting:fix-deprecated-error-api-ref

Conversation

@oharboe
Copy link
Collaborator

@oharboe oharboe commented Mar 6, 2026

No description provided.

Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
Copy link
Contributor

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

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 correctly updates the developer guide to reference the new Logger infrastructure instead of the removed Error.hh. I have one suggestion to improve the documentation by including the default values for the error handling control variables, which was present in the previous version of the document.

Note: Security Review has been skipped due to the limited scope of the PR.

Comment on lines +146 to +153
Tools should report errors to the user using the logging infrastructure
described in the [Logger guide](Logger.md). The `utl::error` function
throws an exception that is caught at the Tcl command level. The variables
`exit_on_error` and `file_continue_on_error` control how the error is
handled. If `exit_on_error` is `1` then OpenROAD reports the error and
exits. If the error is encountered while reading a file with the `source`
or `read_sdc` commands and `file_continue_on_error` is `0` then no other
commands are read from the file.
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

The previous version of this documentation mentioned the default values for exit_on_error and file_continue_on_error. It would be helpful to retain this information for completeness. This suggestion adds that information back, assuming the default behavior is unchanged (previously false, now 0).

Suggested change
Tools should report errors to the user using the logging infrastructure
described in the [Logger guide](Logger.md). The `utl::error` function
throws an exception that is caught at the Tcl command level. The variables
`exit_on_error` and `file_continue_on_error` control how the error is
handled. If `exit_on_error` is `1` then OpenROAD reports the error and
exits. If the error is encountered while reading a file with the `source`
or `read_sdc` commands and `file_continue_on_error` is `0` then no other
commands are read from the file.
Tools should report errors to the user using the logging infrastructure
described in the [Logger guide](Logger.md). The `utl::error` function
throws an exception that is caught at the Tcl command level. The variables
`exit_on_error` and `file_continue_on_error` control how the error is
handled. If `exit_on_error` is `1` then OpenROAD reports the error and
exits. If the error is encountered while reading a file with the `source`
or `read_sdc` commands and `file_continue_on_error` is `0` then no other
commands are read from the file. The default value is `0` for both variables.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 6, 2026

clang-tidy review says "All clean, LGTM! 👍"

@maliberty maliberty enabled auto-merge March 6, 2026 07:16
@maliberty maliberty merged commit c8bfb09 into The-OpenROAD-Project:master Mar 6, 2026
14 checks passed
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