Skip to content

System reset docs #424

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

Merged
merged 7 commits into from
Mar 14, 2018
Merged

System reset docs #424

merged 7 commits into from
Mar 14, 2018

Conversation

bulislaw
Copy link
Member

@bulislaw bulislaw commented Feb 28, 2018

Dependencies

Changes

The actual full diff, after the #423 will be merged:

+### System reset
+
+Mbed OS provides a standardized call to power cycle the system:
+
+```c++
+void system_reset();
+```
+
+After the call the processor and most components will reset, but it will not affect the debug subsystem.

I think the ARMmbed/mbed-os#6230 won't make it for 5.8, that's why I've decided to split out the sleep page improvements out of this PR into #423 which can be independently merged for 5.8.

@AnotherButler

Copy link
Contributor

@AnotherButler AnotherButler left a comment

Choose a reason for hiding this comment

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

Please follow our template with an introduction, a reference link and an example.


[![View code](https://www.mbed.com/embed/?url=https://os.mbed.com/teams/mbed_example/code/SleepManager_Example_1/)](https://os.mbed.com/teams/mbed_example/code/SleepManager_Example_1/file/e85412b4147e/main.cpp)

### System reset
Copy link
Contributor

Choose a reason for hiding this comment

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

Should system reset be the same level as sleep, or is it part of sleep? If the former, it feels out of place to me that it would be between the sleep description and class reference.

Copy link
Member Author

Choose a reason for hiding this comment

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

It's at the same level and the function reference will point to the shared doxygen group "Power management" once doxygen is regenerated.

bulislaw and others added 7 commits March 14, 2018 13:36
* Rename sleep page to power management
* General text improvements
Copy edit for consistent tense and precise language.
* Rename sleep page to power management
* General text improvements
@AnotherButler AnotherButler merged commit f842eca into ARMmbed:new_engine Mar 14, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants