Renovate the psio_error(...) function #2711
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| void psio_error(size_t unit, size_t errval) { | ||
| int i; | ||
| fprintf(stderr, "PSIO_ERROR: unit = %zu, errval = %zu\n", unit, errval); | ||
| void psio_error(size_t unit, size_t errval, std::string prev_msg /* = ""*/) { |
There was a problem hiding this comment.
As a matter of style, how do other developers feel about the /* = ""*/ to note the optional argument in the *.cc file in addition to the *.h file? I oppose it as redundant.
Otherwise, LGTM. Thanks for the renovation. Will approve once the above issue is sorted.
There was a problem hiding this comment.
I had thought some doc scheme picked up on the c-style parameter comments, but I'm not finding evidence. here's a SO on the topic https://stackoverflow.com/a/4989591 . I'm content with having the /* = ""*/ since (1) it's not a blah.h and blah.cc pair and (2) unlikely to fall out-of-date. But I'm not adamant.
There was a problem hiding this comment.
FTR, I'm not adamant either, just want dev discussion.
loriab
approved these changes
Sep 12, 2022
JonathonMisiewicz
approved these changes
Sep 12, 2022
jturney
approved these changes
Sep 15, 2022
8 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Errors in PSIO should probably be handled by calling
psio_error(...), instead of printing the error messages from the function where the error happens.This PR renovates this function to something more C++-style, and adds a new string argument that defaults to the empty string. This allows the callers of the function to prepend their own error messages to the text that eventually ends up in the error box, such as OS supplied error messages when a read/write/lseek system call fails.
This should make it easier to clean up
wt_toclenetc. (see #2700)Todos
psio_error(...)can now take a string argument that will be printed firstStatus