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(+) 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 From 2ec79c6e91d8d407bbd5bf7d304d99effe6dffbd Mon Sep 17 00:00:00 2001 From: take_cheeze Date: Mon, 23 Jun 2014 22:19:28 +0900 Subject: Add documentation of state atexit configuration. --- doc/mrbconf/README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/doc/mrbconf/README.md b/doc/mrbconf/README.md index 14cd23834..f0dd50da5 100644 --- a/doc/mrbconf/README.md +++ b/doc/mrbconf/README.md @@ -93,3 +93,14 @@ largest value of required alignment. * Default value is `16000`. * Specifies page size of pool page. * Smaller the value is increases memory overhead. + +## State atexit configuration. + +`MRB_FIXED_STATE_ATEXIT_STACK` +* If defined enables fixed size `mrb_state` atexit stack. +* Raises `RuntimeError` when `mrb_state_atexit` call count to same `mrb_state` exceeds +`MRB_FIXED_STATE_ATEXIT_STACK_SIZE`'s value. + +`MRB_FIXED_STATE_ATEXIT_STACK_SIZE` +* Default value is `5`. +* If `MRB_FIXED_STATE_ATEXIT_STACK` isn't defined this macro is ignored. -- cgit v1.2.3