Skip to content

Sleep handbook improvements #423

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 5 commits into from
Mar 14, 2018
Merged

Sleep handbook improvements #423

merged 5 commits into from
Mar 14, 2018

Conversation

bulislaw
Copy link
Member

  • Rename sleep page to power management - as we are looking into adding more related functions (like reset).
  • General text improvements

@AnotherButler

@bulislaw bulislaw mentioned this pull request Feb 28, 2018
Merged
2 tasks
AnotherButler
AnotherButler suggested changes Feb 28, 2018
View reviewed changes
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.

I've left some comments and queries for you to address.

docs/reference/api/platform/PowerManagement.md Outdated
}
```

### Function reference
Copy link
Contributor

Choose a reason for hiding this comment

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

Query: Should this really be at the same level as idle loop? Also, should this be moved up? Right now, it looks like it's the function reference of idle loop, but it's the function reference of sleep.

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'll be reference for the power management API. That's why it has the same level as the other sections.

docs/reference/api/platform/PowerManagement.md Outdated

[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/v5.7/mbed-os-api-doxy/mbed__sleep_8h_source.html)

### Example
Copy link
Contributor

Choose a reason for hiding this comment

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

See above comment.

docs/reference/api/platform/PowerManagement.md

This mode is similar to sleep but saves more power and has a longer wakeup time. It saves additional power by turning off the high-speed clocks. Because of this, you can only enter this mode when peripherals relying on high-speed clocks are not in use. Peripherals that do not rely on high-speed clocks include the LowPowerTicker, RTC and InterruptIn APIs. This mode maintains all state.

#### Sleep manager
Copy link
Contributor

Choose a reason for hiding this comment

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

Query: Are there supposed to be two sections called "Sleep manager"? This seems confusing to me.

@bulislaw
Copy link
Member Author

bulislaw commented Mar 1, 2018

Some reshuffling:

  • I've kept the Sleep, Idle loop and Function reference (and reset via second PR) at level 3.
  • I've moved example to sleep section as it's sleep only related.
  • I've added extra reference section to idle loop as it's part of RTOS doxy group

I'm not sure it's the right outline, but it makes sense I think. Power management has 3 functionalities, two of which live in platform/ (reset, sleep) and one in rtos/ (idle loop) both the code and the doxy groups. So the final toc will look like (including #424):

  • Sleep
    • ...
    • Example
  • Reset
  • Reference
  • Idle loop
    • Reference

If you have any ideas how to make it better please do let me know :)

@bulislaw bulislaw mentioned this pull request Mar 2, 2018
Merged
1 task
@AnotherButler
Copy link
Contributor

AnotherButler commented Mar 7, 2018 •
edited
Loading

It looks like #424 overrides this one. Can I close this one?

@AnotherButler
Copy link
Contributor

Never mind. I just saw the dependency note on the next one.

@AnotherButler
Copy link
Contributor

None of these follow our template, so I don't want to merge them.

@bulislaw
Copy link
Member Author

bulislaw commented Mar 8, 2018 •
edited
Loading

What's our template? This doesn't add any docs just makes improvements to the text and renames the page, for some reason git is showing it as delete and add new stuff.

@AnotherButler
Copy link
Contributor

This is our template: https://docs.internal.mbed.com/docs/master/engineers/mbed-os-user-api-class-reference.html

Could we move idle loop to its own page and create an example for it? I think that would help this page. Also, I notice in the Doxygen, it's "idle hook" rather than "idle loop". Which is correct?

@AnotherButler
Copy link
Contributor

@bulislaw Could you please solve the merge conflicts?

bulislaw and others added 5 commits March 14, 2018 13:36
@bulislaw
Sleep handbook improvements
840a25d 
* Rename sleep page to power management
* General text improvements
@bulislaw
Copy edit PowerManagement.md
4ca3495 
Copy edit for consistent tense and precise language.
@bulislaw
Fix reported issues
50d8931
@bulislaw
Link idle loop doxygen
7b43f83
@bulislaw
Update doxygen link to point to Power Management group
26f3bc8
@AnotherButler AnotherButler merged commit d4690da 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
Reviewers

@AnotherButler AnotherButler AnotherButler approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@bulislaw @AnotherButler