Skip to content

Commit d303d01

Browse files
committed
update comments
1 parent 5653249 commit d303d01

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

cores/esp8266/heap.cpp

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -798,9 +798,15 @@ uint32 IRAM_ATTR user_iram_memory_is_enabled(void)
798798

799799

800800
///////////////////////////////////////////////////////////////////////////////
801-
// heap allocator for "new" (ABI) - To support collecting OOM info, always defined
801+
// Not normally needed, DEV_DEBUG_ABI_CPP is for module maintenance.
802802
#if DEV_DEBUG_ABI_CPP
803803
// In test Sketch, set abi_new_print=true/false around test function calls.
804+
//
805+
// Note that this code path is skipped when built with "C++ Exception: enabled"
806+
// and the non-debug build option. For this build case, there is no need to
807+
// collect OOM information. To use DEV_DEBUG_ABI_CPP, you must also define one
808+
// of the following: MIN_ESP_OOM, DEBUG_ESP_OOM, DEBUG_ESP_PORT, or
809+
// DEBUG_ESP_WITHINISR.
804810
bool abi_new_print = false;
805811
#define DEBUG_ABI_CPP_PRINTF ets_uart_printf
806812

@@ -828,7 +834,9 @@ extern "C" void _dbg_abi_print_pstr(const char *function_name) {
828834
#define DEBUG_ABI_CPP_PRINTF(...)
829835
#endif
830836

831-
837+
///////////////////////////////////////////////////////////////////////////////
838+
// heap allocator for "new" (ABI) - To support collecting OOM info, always defined
839+
//
832840
#undef USE_HEAP_ABI_MEMALIGN
833841
#undef USE_HEAP_ABI_MALLOC
834842

0 commit comments

Comments
 (0)