summaryrefslogtreecommitdiffhomepage
path: root/doc
diff options
context:
space:
mode:
authortake_cheeze <[email protected]>2014-06-25 21:34:52 +0900
committertake_cheeze <[email protected]>2014-06-25 21:34:52 +0900
commit090a8889f7a740cd760c19c418bbfd2cb60b1ff1 (patch)
treecaec28927f30e0116c646483f885b1853f3064eb /doc
parentd4e49c9f8fe752e8f7d3d6b9dc10a55307654dfd (diff)
downloadmruby-090a8889f7a740cd760c19c418bbfd2cb60b1ff1.tar.gz
mruby-090a8889f7a740cd760c19c418bbfd2cb60b1ff1.zip
Add documentation of `mrb_value` config.
Diffstat (limited to 'doc')
-rw-r--r--doc/mrbconf/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/mrbconf/README.md b/doc/mrbconf/README.md
index f0dd50da5..e8da29e43 100644
--- a/doc/mrbconf/README.md
+++ b/doc/mrbconf/README.md
@@ -104,3 +104,18 @@ largest value of required alignment.
`MRB_FIXED_STATE_ATEXIT_STACK_SIZE`
* Default value is `5`.
* If `MRB_FIXED_STATE_ATEXIT_STACK` isn't defined this macro is ignored.
+
+## `mrb_value` configuration.
+
+`MRB_ENDIAN_BIG`
+* If defined compiles mruby for big endian machines.
+* Used in `MRB_NAN_BOXING`.
+* Some mrbgem use this mrbconf.
+
+`MRB_NAN_BOXING`
+* If defined represent `mrb_value` in boxed `double`.
+* Conflicts with `MRB_USE_FLOAT`.
+
+`MRB_WORD_BOXING`
+* If defined represent `mrb_value` as a word.
+* If defined `Float` will be a mruby object with `RBasic`.