-
Notifications
You must be signed in to change notification settings - Fork 3k
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.
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
Change Mutex lock and unlock APIs return value to void #12598
Conversation
ed5a921
to
8603d2b
Compare
rtos/Mutex.h
Outdated
@note You cannot call this function from ISR context. | ||
@note This function treats RTOS errors as fatal system errors, so it can only return osOK. | ||
Use of the return value is deprecated, as the return is expected to become void in the future. | ||
@note This function treats RTOS errors as fatal system errors, so it might not return. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"It might not return" sounds a bit odd. I can't think of a better phrase to substitute. I think I'd be tempted to just stop at the comma, or maybe drop the note altogether.
It was only really to explain that people shouldn't be looking at the return code, and I don't think it's needed any more.
d22b90d
to
b67258e
Compare
b67258e
to
30852be
Compare
@kjbracey-arm could you please review the updates thanks. |
CI started in the interim |
Test run: FAILEDSummary: 3 of 4 test jobs failed Failed test jobs:
|
CI restarted |
Test run: FAILEDSummary: 1 of 8 test jobs failed Failed test jobs:
|
CI restarted |
Test run: SUCCESSSummary: 8 of 8 test jobs passed |
This PR does not contain release version label after merging. |
Summary of changes
Modified Mutex lock() and unlock() APIs to return
void
as return status value deprecated.Impact of changes
Breaking change: Mutex
lock()
andunlock()
methods return status value have been deprecated since Mbed OS 5.9, so changed the return value tovoid
.Migration actions required
Use Mutex
void lock()
,void unlock()
methods.Documentation
None
Pull request type
Test results
Reviewers
@evedon