Skip to content

Build profile docs change related to sleep #140

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

Merged
merged 3 commits into from
Jun 19, 2017
Merged

Build profile docs change related to sleep #140

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1d7783d
Build profile docs change related to sleep
bulislaw Mar 31, 2017
7ee4f3f
Make clear chip is put to sleep while using develop profile
bulislaw Apr 5, 2017
8eacd82
Avoid the passive voice in profile's docs
bulislaw Apr 6, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/dev_tools/build_profiles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,15 @@ mbed OS 5 supports three primary build profiles: *develop*, *debug* and *release
* Small and fast code.
* Full error information. For example, asserts have file name and line number.
* Hard to follow code flow when using a debugger.
* Chip is put to sleep when going idle:
Copy link
Contributor

Choose a reason for hiding this comment

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

Query: Could we change this to "Chip goes to sleep we idle" and keep the meaning? I would like to avoid the passive voice in "is put to sleep".

Copy link
Contributor

@Patater Patater Apr 5, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

"The RTOS idle task puts the chip to sleep." is accurate, but maybe too detailed.

"The chip sleeps when idle." is accurate as well.

* Debugger is likely to drop connection.
* Breaks the local file system on the [mbed interface](https://docs.mbed.com/docs/mbed-os-handbook/en/latest/getting_started/mbed_interface/) on some boards.

## Debug profile
* Largest and slowest profile.
* Full error information. For example, asserts have file name and line number.
* Easy to step through code with a debugger.
* Disabled sleep mode.

## Release profile
* Smallest profile and still fast.
Expand Down