diff options
| author | Dirk Ziegelmeier <[email protected]> | 2019-01-28 14:05:05 +0100 |
|---|---|---|
| committer | Simon Goldschmidt <[email protected]> | 2019-02-18 12:58:27 +0100 |
| commit | 5378fd84df498759d4ba231f6ca3a42d6aa0fb93 (patch) | |
| tree | 06ec9bce222004ff1a53164302e60e6503cff63d | |
| parent | 9d8b8d9c6943a29c5be58db99c555bbc72ca80b2 (diff) | |
Add documentation on how to debug memory pool sizes
(cherry picked from commit a215eba50eae2320bf9e10499f6b05d9c7639074)
| -rw-r--r-- | doc/doxygen/main_page.h | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/doxygen/main_page.h b/doc/doxygen/main_page.h index 89d86f82..06b79373 100644 --- a/doc/doxygen/main_page.h +++ b/doc/doxygen/main_page.h @@ -205,6 +205,15 @@ */ /** + * @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 * BEFORE submitting, please check if the bug has already been reported!\n |