summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authortake_cheeze <[email protected]>2014-06-23 22:19:28 +0900
committertake_cheeze <[email protected]>2014-06-23 22:19:28 +0900
commit2ec79c6e91d8d407bbd5bf7d304d99effe6dffbd (patch)
tree47f9f83b40ba7e835a87c070d97a1ac09c3e7e9f
parent6336dbb653c25e48d62fd66352bab4d59923dec2 (diff)
downloadmruby-2ec79c6e91d8d407bbd5bf7d304d99effe6dffbd.tar.gz
mruby-2ec79c6e91d8d407bbd5bf7d304d99effe6dffbd.zip
Add documentation of state atexit configuration.
-rw-r--r--doc/mrbconf/README.md11
1 files changed, 11 insertions, 0 deletions
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.