Skip to content

Add notes about ISR safety to RTOS doxygen #5760

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

Jump to bottom
Merged
merged 10 commits into from
Jan 15, 2018
Merged

Add notes about ISR safety to RTOS doxygen #5760

merged 10 commits into from
Jan 15, 2018

Conversation

bulislaw
Copy link
Member

Description

Extend docs for RTOS functions to include information whether they are ISR safe.

Status

READY

@bulislaw bulislaw self-assigned this Dec 27, 2017
@0xc0170 0xc0170 requested a review from c1728p9 January 8, 2018 13:15
0xc0170
0xc0170 approved these changes Jan 8, 2018
View reviewed changes
Copy link
Contributor

@0xc0170 0xc0170 left a comment

Choose a reason for hiding this comment

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

This sets precedence that each method should contain a note about ISR safety (we always only provide a note about thread/interrupt safety per class).

@bulislaw
Copy link
Member Author

bulislaw commented Jan 8, 2018

At least for the RTOS as these are basic primitives and their usage should restriction should be clear.

@theotherjimmy
Copy link
Contributor

@AnotherButler Could you review? Looks like docs changes!

Amanda Butler added 9 commits January 8, 2018 17:36
Copy edit ConditionVariable.h
c23709c 
Copy edit docs changes for active voice.
Copy edit EventFlags.h
30b8da9 
Copy edit file for active voice and agreement.
Copy edit Mail.h
d4b3da6 
Copy edit file for active voice and American English.
Copy edit MemoryPool.h
4a3c9ef 
Copy edit file for active voice.
Copy edit Mutex.h
0d772db 
Copy edit file for active voice.
Copy edit Queue.h
61b2cbb 
Copy edit file for active voice.
Copy edit RtosTimer.h
c3b6c4d 
Copy edit file for active voice.
Copy edit Semaphore.h
3621536 
Copy edit file for active voice.
Copy edit Thread.h
ec681b6 
Copy edit file for active voice.
@0xc0170
Copy link
Contributor

0xc0170 commented Jan 10, 2018

@AnotherButler Approved now?

I assume we will squash this into one commit prior the integration.

@0xc0170
Copy link
Contributor

0xc0170 commented Jan 12, 2018

/morph build

@mbed-ci
Copy link

mbed-ci commented Jan 12, 2018

Build : SUCCESS

Build number : 854
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/5760/

Triggering tests

/morph test
/morph uvisor-test
/morph export-build

@mbed-ci
Copy link

mbed-ci commented Jan 12, 2018

Exporter Build : SUCCESS

Build number : 525
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/exporter/5760/

@mbed-ci
Copy link

mbed-ci commented Jan 12, 2018

Test : FAILURE

Build number : 698
Test logs :http://mbed-os-logs.s3-website-us-west-1.amazonaws.com/?prefix=logs/5760/698

@studavekar studavekar mentioned this pull request Jan 12, 2018
Closed
@0xc0170
Copy link
Contributor

0xc0170 commented Jan 15, 2018

/morph test

@mbed-ci
Copy link

mbed-ci commented Jan 15, 2018

Test : SUCCESS

Build number : 705
Test logs :http://mbed-os-logs.s3-website-us-west-1.amazonaws.com/?prefix=logs/5760/705

@0xc0170 0xc0170 merged commit 940614c into ARMmbed:master Jan 15, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@0xc0170 0xc0170 0xc0170 approved these changes

@AnotherButler AnotherButler AnotherButler approved these changes

@c1728p9 c1728p9 Awaiting requested review from c1728p9

Assignees

@bulislaw bulislaw

Labels
release-version: 5.7.4
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@bulislaw @theotherjimmy @0xc0170 @mbed-ci @AnotherButler