diff options
| author | Yukihiro "Matz" Matsumoto <[email protected]> | 2014-06-24 04:50:27 +0900 |
|---|---|---|
| committer | Yukihiro "Matz" Matsumoto <[email protected]> | 2014-06-24 04:50:27 +0900 |
| commit | 08cfd9e63728db3a06a0e8c59b7caec30cd93e24 (patch) | |
| tree | 47f9f83b40ba7e835a87c070d97a1ac09c3e7e9f | |
| parent | c938b2f65647aae87a7bcfeb3a9462b90aaa0ce4 (diff) | |
| parent | 2ec79c6e91d8d407bbd5bf7d304d99effe6dffbd (diff) | |
| download | mruby-08cfd9e63728db3a06a0e8c59b7caec30cd93e24.tar.gz mruby-08cfd9e63728db3a06a0e8c59b7caec30cd93e24.zip | |
Merge pull request #2415 from take-cheeze/mrbconf_doc
Add mrbconf document.
| -rw-r--r-- | doc/mrbconf/README.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/mrbconf/README.md b/doc/mrbconf/README.md index 813b80839..f0dd50da5 100644 --- a/doc/mrbconf/README.md +++ b/doc/mrbconf/README.md @@ -81,3 +81,26 @@ 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. + +## 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. |