Skip to content
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

Merged
merged 2 commits into from
Mar 11, 2020

Conversation

rajkan01
Copy link
Contributor

@rajkan01 rajkan01 commented Mar 9, 2020

Summary of changes

Modified Mutex lock() and unlock() APIs to returnvoid as return status value deprecated.

Impact of changes

Breaking change: Mutex lock() and unlock() methods return status value have been deprecated since Mbed OS 5.9, so changed the return value to void.

Migration actions required

Use Mutex void lock(), void unlock() methods.

Documentation

None


Pull request type

[] Patch update (Bug fix / Target update / Docs update / Test update / Refactor)
[] Feature update (New feature / Functionality change / New API)
[x] Major update (Breaking change E.g. Return code change / API behaviour change)

Test results

[] No Tests required for this change (E.g docs only update)
[x] Covered by existing mbed-os tests (Greentea or Unittest)
[] Tests / results supplied as part of this PR

Reviewers

@evedon


@mergify mergify bot added the needs: work label Mar 9, 2020
evedon
evedon previously requested changes Mar 9, 2020
@rajkan01 rajkan01 force-pushed the mutex_lock_remove_return branch from ed5a921 to 8603d2b Compare March 9, 2020 16:06
@mergify mergify bot dismissed evedon’s stale review March 9, 2020 16:07

Pull request has been modified.

evedon
evedon previously approved these changes Mar 9, 2020
@mergify mergify bot dismissed evedon’s stale review March 9, 2020 17:15

Pull request has been modified.

@ciarmcom ciarmcom requested review from evedon and a team March 9, 2020 18:00
@ciarmcom
Copy link
Member

ciarmcom commented Mar 9, 2020

@rajkan01, thank you for your changes.
@evedon @ARMmbed/mbed-os-core @ARMmbed/mbed-os-maintainers please review.

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.
Copy link
Contributor

@kjbracey kjbracey Mar 10, 2020

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.

@rajkan01 rajkan01 force-pushed the mutex_lock_remove_return branch from d22b90d to b67258e Compare March 10, 2020 12:06
@mergify mergify bot removed the needs: review label Mar 10, 2020
@rajkan01 rajkan01 force-pushed the mutex_lock_remove_return branch from b67258e to 30852be Compare March 10, 2020 12:14
@adbridge
Copy link
Contributor

@kjbracey-arm could you please review the updates thanks.

@adbridge
Copy link
Contributor

CI started in the interim

@mbed-ci
Copy link

mbed-ci commented Mar 10, 2020

Test run: FAILED

Summary: 3 of 4 test jobs failed
Build number : 1
Build artifacts

Failed test jobs:

  • jenkins-ci/mbed-os-ci_build-ARM
  • jenkins-ci/mbed-os-ci_build-GCC_ARM
  • jenkins-ci/mbed-os-ci_build-IAR

kjbracey
kjbracey previously approved these changes Mar 10, 2020
@mergify mergify bot added needs: CI and removed needs: work labels Mar 10, 2020
@mergify mergify bot dismissed kjbracey’s stale review March 10, 2020 14:51

Pull request has been modified.

@adbridge
Copy link
Contributor

CI restarted

@mbed-ci
Copy link

mbed-ci commented Mar 10, 2020

Test run: FAILED

Summary: 1 of 8 test jobs failed
Build number : 2
Build artifacts

Failed test jobs:

  • jenkins-ci/mbed-os-ci_greentea-test

@mergify mergify bot added needs: work and removed needs: CI labels Mar 10, 2020
@adbridge
Copy link
Contributor

CI restarted

@mbed-ci
Copy link

mbed-ci commented Mar 11, 2020

Test run: SUCCESS

Summary: 8 of 8 test jobs passed
Build number : 3
Build artifacts

@mergify
Copy link

mergify bot commented Mar 11, 2020

This PR does not contain release version label after merging.

@mergify mergify bot added the release version missing When PR does not contain release version, bot should label it and we fix it afterwards label Mar 11, 2020
@0xc0170 0xc0170 removed the release version missing When PR does not contain release version, bot should label it and we fix it afterwards label Aug 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants