Skip to content

Commit b6929fd

Browse files
committedAug 27, 2024
Add notes regarding expected failures
1 parent 14533fd commit b6929fd

File tree

1 file changed

+14
-4
lines changed
  • config/esp32/components/chip

1 file changed

+14
-4
lines changed
 

‎config/esp32/components/chip/Kconfig

+14-4
Original file line numberDiff line numberDiff line change
@@ -168,10 +168,20 @@ menu "CHIP Core"
168168
default n
169169
help
170170
This option enables the use of heap memory to allocate object pools.
171-
When this option is enabled, it does not pre-allocate the object pools.
172-
Additionally, there is no limit, (i.e. free heap is the limit) on the
173-
maximum number of entries that can be allocated.
174-
This option can be usefull if you run into static DRAM overflow.
171+
When enabled, object pools are not pre-allocated.
172+
Additionally, the maximum number of entries that can be allocated is
173+
only limited by the available heap memory.
174+
175+
This option can be useful if you encounter static DRAM overflow.
176+
177+
NOTE: Since there is no cap on pool sizes, this may lead to issues
178+
where embedded code assumes the pool size is limited, and no other
179+
mechanisms are in place to restrict the size of allocations.
180+
181+
NOTE: If enabled and the free heap is exhausted, this may result in
182+
undefined behavior, potential non-compliance with specifications,
183+
or failure during certification tests. Even if it passes, it may fail
184+
to function properly with actual controllers.
175185

176186
endmenu # "General Options"
177187

0 commit comments

Comments
 (0)