From 6336dbb653c25e48d62fd66352bab4d59923dec2 Mon Sep 17 00:00:00 2001 From: take_cheeze Date: Mon, 23 Jun 2014 22:12:58 +0900 Subject: Add documentation of memory pool configurations. --- doc/mrbconf/README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'doc') diff --git a/doc/mrbconf/README.md b/doc/mrbconf/README.md index 813b80839..14cd23834 100644 --- a/doc/mrbconf/README.md +++ b/doc/mrbconf/README.md @@ -81,3 +81,15 @@ will be defined as `mrb_int`. * Default value is 100. * Ignored when `MRB_GC_FIXED_ARENA` isn't defined. * Defines fixed GC arena size. + +## Memory pool configuration. + +`POOL_ALIGNMENT` +* Default value is `4`. +* If you're allocating data types that requires alignment more than default value define the +largest value of required alignment. + +`POOL_PAGE_SIZE` +* Default value is `16000`. +* Specifies page size of pool page. +* Smaller the value is increases memory overhead. -- cgit v1.2.3