Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
maliberty merged 1 commit into from
Mar 6, 2026
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions docs/contrib/DeveloperGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,15 +143,14 @@ manpages.

## Errors

Tools should report errors to the user using the `ord::error` function
defined in `include/openroad/Error.hh`. `ord::error` throws
`ord::Exception`. The variables `ord::exit_on_error` and
`ord::file_continue_on_error` control how the error is handled. If
`ord::exit_on_error` is `true` then OpenROAD reports the error and exits. If
the error is encountered while reading a file with the `source` or
`read_sdc` commands and `ord::file_continue_on_error` is `false` then no
other commands are read from the file. The default value is `false` for both
variables.
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.
Comment on lines +146 to +153
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Mar 6, 2026

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.


## Test

Expand Down
Loading