Skip to content

Commit eb52f98

Browse files
Andy Rossnashif
authored andcommitted
release-notes-2.5: Note k_mem_pool removal
This is a removed API, should be called out here. Also include a behavioral note, as I don't think we did in release notes this when k_heap was introduced. Signed-off-by: Andy Ross <[email protected]>
1 parent dea8fcc commit eb52f98

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

doc/releases/release-notes-2.5.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,16 @@ Removed APIs in this release
117117
* The deprecated BT_HCI_ERR_AUTHENTICATION_FAIL define has been removed,
118118
use BT_HCI_ERR_AUTH_FAIL instead.
119119

120+
* Kernel
121+
122+
* The deprecated k_mem_pool API has been removed entirely (for the
123+
past release it was backed by a k_heap, but maintained a
124+
compatible API). Now all instantiated heaps must be
125+
sys_heap/k_heaps. Note that the new-style heap is a general
126+
purpose allocator and does not make the same promises about block
127+
alignment/splitting. Applications with such requirements should
128+
look at porting their logic, or perhaps at the k_mem_slab utility.
129+
120130
Stable API changes in this release
121131
==================================
122132

0 commit comments

Comments
 (0)