FileHandle: Mbed OS 5.12 updates #992
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
Cover changes in ARMmbed/mbed-os#9797
SeppoTakalo
approved these changes
Mar 6, 2019
added 2 commits
March 6, 2019 18:44
Make minor edits, mostly for style, and fix some existing oddly formatted bullets while I'm at it.
Edit file, mostly for consistent tense across docs.
docs/api/platform/FileHandle.md
Outdated
|
|
||
| Having a device open through a `FileHandle` may cost power, especially if open for input. For example, for `UARTSerial` to be able to receive data, the system must not enter deep sleep, so deep sleep is prevented while the `UARTSerial` is active. | ||
|
|
||
| To permit power saving, you can close or destroy the device, or you can indicate that you do not currently require input or output by calling `FileHandle::enable_input` or `FileHandle::enable_output`. Disabling input or output effectively suspends the device in that direction, which can permit power saving. |
There was a problem hiding this comment.
What do we mean by destroy the device to permit power saving? This sounds counterintuitive to me.
There was a problem hiding this comment.
That should be close or destroy the FileHandle (by which you're accessing the device, which would then permit the device to shut down).
Clarify sentence based on suggestion in comments.
AnotherButler
approved these changes
Mar 7, 2019
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.
Cover changes in ARMmbed/mbed-os#9797