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

Add notes about ISR safety to RTOS doxygen #5760

Merged
merged 10 commits into from Jan 15, 2018

Conversation

Projects
None yet
5 participants
@bulislaw
Member

bulislaw commented Dec 27, 2017

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 Jan 8, 2018

@0xc0170

0xc0170 approved these changes Jan 8, 2018

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

This comment has been minimized.

Member

bulislaw commented Jan 8, 2018

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

@theotherjimmy

This comment has been minimized.

Contributor

theotherjimmy commented Jan 8, 2018

@AnotherButler Could you review? Looks like docs changes!

AnotherButler added some commits Jan 8, 2018

Copy edit ConditionVariable.h
Copy edit docs changes for active voice.
Copy edit EventFlags.h
Copy edit file for active voice and agreement.
Copy edit Mail.h
Copy edit file for active voice and American English.
Copy edit MemoryPool.h
Copy edit file for active voice.
Copy edit Mutex.h
Copy edit file for active voice.
Copy edit Queue.h
Copy edit file for active voice.
Copy edit RtosTimer.h
Copy edit file for active voice.
Copy edit Semaphore.h
Copy edit file for active voice.
Copy edit Thread.h
Copy edit file for active voice.
@0xc0170

This comment has been minimized.

Member

0xc0170 commented Jan 10, 2018

@AnotherButler Approved now?

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

@0xc0170 0xc0170 added needs: CI and removed needs: review labels Jan 12, 2018

@0xc0170

This comment has been minimized.

Member

0xc0170 commented Jan 12, 2018

/morph build

@mbed-ci

This comment has been minimized.

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

This comment has been minimized.

@mbed-ci

This comment has been minimized.

@0xc0170

This comment has been minimized.

Member

0xc0170 commented Jan 15, 2018

/morph test

@mbed-ci

This comment has been minimized.

@0xc0170 0xc0170 added ready for merge and removed needs: CI labels Jan 15, 2018

@0xc0170 0xc0170 merged commit 940614c into ARMmbed:master Jan 15, 2018

19 checks passed

ARM mbed CI Verification build successful.
Details
AWS-CI uVisor Build & Test Success
Details
ci-morph-build build completed
Details
ci-morph-exporter build completed
Details
ci-morph-test test completed
Details
continuous-integration/jenkins/pr-head This commit looks good
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
travis-ci/docs Local docs testing has passed
Details
travis-ci/events Local events testing has passed
Details
travis-ci/littlefs Local littlefs testing has passed
Details
travis-ci/mbed2-ATMEL Local mbed2-ATMEL testing has passed
Details
travis-ci/mbed2-MAXIM Local mbed2-MAXIM testing has passed
Details
travis-ci/mbed2-NORDIC Local mbed2-NORDIC testing has passed
Details
travis-ci/mbed2-NUVOTON Local mbed2-NUVOTON testing has passed
Details
travis-ci/mbed2-NXP Local mbed2-NXP testing has passed
Details
travis-ci/mbed2-RENESAS Local mbed2-RENESAS testing has passed
Details
travis-ci/mbed2-SILICON_LABS Local mbed2-SILICON_LABS testing has passed
Details
travis-ci/mbed2-STM Local mbed2-STM testing has passed
Details
travis-ci/tools Local tools testing has passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment