From a215eba50eae2320bf9e10499f6b05d9c7639074 Mon Sep 17 00:00:00 2001 From: Dirk Ziegelmeier Date: Mon, 28 Jan 2019 14:05:05 +0100 Subject: [PATCH] Add documentation on how to debug memory pool sizes --- doc/doxygen/main_page.h | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/doc/doxygen/main_page.h b/doc/doxygen/main_page.h index 55b36b15..6fa2c916 100644 --- a/doc/doxygen/main_page.h +++ b/doc/doxygen/main_page.h @@ -209,6 +209,15 @@ * Read especially sections "Cache coherency" and "Buffer alignment". */ +/** + * @page mem_err Debugging memory pool sizes + * If you have issues with lwIP and you are using memory pools, check that your pools + * are correctly sized.\n + * To debug pool sizes, \#define LWIP_STATS and MEMP_STATS to 1. Check the global variable + * lwip_stats.memp[] using a debugger. If the "err" member of a pool is > 0, the pool + * may be too small for your application and you need to increase its size. + */ + /** * @page bugs Reporting bugs * Please report bugs in the lwIP bug tracker at savannah.\n