From 090a8889f7a740cd760c19c418bbfd2cb60b1ff1 Mon Sep 17 00:00:00 2001 From: take_cheeze Date: Wed, 25 Jun 2014 21:34:52 +0900 Subject: Add documentation of `mrb_value` config. --- doc/mrbconf/README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) (limited to 'doc') 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`. -- cgit v1.2.3 From 340279885e8f8b5dee6b47667ca1cb2d74496172 Mon Sep 17 00:00:00 2001 From: take_cheeze Date: Wed, 25 Jun 2014 21:41:54 +0900 Subject: Add notes about restriction of `DISABLE_STDIO`. --- doc/mrbconf/README.md | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'doc') diff --git a/doc/mrbconf/README.md b/doc/mrbconf/README.md index e8da29e43..698d2526f 100644 --- a/doc/mrbconf/README.md +++ b/doc/mrbconf/README.md @@ -17,6 +17,10 @@ You can use mrbconfs with following ways: `DISABLE_STDIO` * When defined `` functions won't be used. +* Some features will be disabled when this is enabled: + * `mrb_irep` load/dump from/to file. + * Compiling mruby script from file. + * Printing features in **src/print.c**. ## Debug macros. `ENABLE_DEBUG` -- cgit v1.2.3