summaryrefslogtreecommitdiffhomepage
path: root/doc
diff options
context:
space:
mode:
authortake_cheeze <[email protected]>2014-06-23 22:12:58 +0900
committertake_cheeze <[email protected]>2014-06-23 22:12:58 +0900
commit6336dbb653c25e48d62fd66352bab4d59923dec2 (patch)
tree0ed4d85b52494b8de05dc340f73642bc3d329569 /doc
parentc938b2f65647aae87a7bcfeb3a9462b90aaa0ce4 (diff)
downloadmruby-6336dbb653c25e48d62fd66352bab4d59923dec2.tar.gz
mruby-6336dbb653c25e48d62fd66352bab4d59923dec2.zip
Add documentation of memory pool configurations.
Diffstat (limited to 'doc')
-rw-r--r--doc/mrbconf/README.md12
1 files changed, 12 insertions, 0 deletions
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.