Skip to content
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

k_heap / sys_heap needs overview documentation #24359

Closed
andrewboie opened this issue Apr 14, 2020 · 1 comment · Fixed by #24742
Closed

k_heap / sys_heap needs overview documentation #24359

andrewboie opened this issue Apr 14, 2020 · 1 comment · Fixed by #24742
Assignees
Labels
area: Documentation area: Kernel Enhancement Changes/Updates/Additions to existing features
Milestone

Comments

@andrewboie
Copy link
Contributor

andrewboie commented Apr 14, 2020

We've introduced new heap APIs to supersede k_mem_pool / sys_mem_pool, but have no overview documentation for it, just API doxygen.

I expect this file will need to be rewritten to reflect the new API set:

doc/reference/kernel/memory/pools.rst

@andrewboie andrewboie added bug The issue is a bug, or the PR is fixing a bug area: Documentation area: Kernel labels Apr 14, 2020
@carlescufi carlescufi added Enhancement Changes/Updates/Additions to existing features and removed bug The issue is a bug, or the PR is fixing a bug labels Apr 21, 2020
@carlescufi carlescufi added this to the v2.3.0 milestone Apr 21, 2020
@carlescufi
Copy link
Member

carlescufi commented Apr 21, 2020

@andrewboie and @andyross don't forget to update docs/releases/, section about API deprecation. Either as part of this or as part of #24358

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: Documentation area: Kernel Enhancement Changes/Updates/Additions to existing features
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants