changeset 2081:f29bd40e9a62

Development guide: documented ngx_create_pool() size requirements.
author Ruslan Ermilov <ru@nginx.com>
date Tue, 05 Dec 2017 16:54:22 +0300
parents 8f885a69374d
children fee7627f6a5a
files xml/en/docs/dev/development_guide.xml
diffstat 1 files changed, 3 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/dev/development_guide.xml
+++ b/xml/en/docs/dev/development_guide.xml
@@ -1506,6 +1506,9 @@ The following operations are supported:
 <literal>ngx_create_pool(size, log)</literal> — Create a pool with specified
 block size.
 The pool object returned is allocated in the pool as well.
+The <literal>size</literal>
+should be at least <literal>NGX_MIN_POOL_SIZE</literal>
+and a multiple of <literal>NGX_POOL_ALIGNMENT</literal>.
 </listitem>
 
 <listitem>