diff options
| author | KOBAYASHI Shuji <[email protected]> | 2020-11-21 21:14:40 +0900 |
|---|---|---|
| committer | KOBAYASHI Shuji <[email protected]> | 2020-11-21 21:14:40 +0900 |
| commit | 3d056d084aedd2a1a3a36e33b1cef4e90d282813 (patch) | |
| tree | f463c5ac01e1a32a6dea5b6868e2794f6b0479ef /doc | |
| parent | 544784effd251656f7b406bc94880e1ef75af7b5 (diff) | |
| download | mruby-3d056d084aedd2a1a3a36e33b1cef4e90d282813.tar.gz mruby-3d056d084aedd2a1a3a36e33b1cef4e90d282813.zip | |
Rename `MRB_{ENABLE,DISABLE}_` to `MRB_{USE,NO}_`; close #5163
| Previous Name | New Name |
|------------------------------|-------------------------|
| MRB_ENABLE_ALL_SYMBOLS | MRB_USE_ALL_SYMBOLS |
| MRB_ENABLE_SYMBOLL_ALL | MRB_USE_ALL_SYMBOLS |
| MRB_ENABLE_CXX_ABI | MRB_USE_CXX_ABI |
| MRB_ENABLE_CXX_EXCEPTION | MRB_USE_CXX_EXCEPTION |
| MRB_ENABLE_DEBUG_HOOK | MRB_USE_DEBUG_HOOK |
| MRB_DISABLE_DIRECT_THREADING | MRB_NO_DIRECT_THREADING |
| MRB_DISABLE_STDIO | MRB_NO_STDIO |
| ENABLE_LINENOISE | MRB_USE_LINENOISE |
| ENABLE_READLINE | MRB_USE_READLINE |
| DISABLE_MIRB_UNDERSCORE | MRB_NO_MIRB_UNDERSCORE |
| DISABLE_GEMS | MRB_NO_GEMS |
* `MRB_ENABLE_SYMBOLL_ALL` seems to be a typo, so it is fixed.
* `MRB_` prefix is added to those without.
* The previous names can also be used for compatibility.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/guides/compile.md | 2 | ||||
| -rw-r--r-- | doc/guides/mrbconf.md | 6 |
2 files changed, 4 insertions, 4 deletions
diff --git a/doc/guides/compile.md b/doc/guides/compile.md index d4d0fdc75..9ee56d4cf 100644 --- a/doc/guides/compile.md +++ b/doc/guides/compile.md @@ -503,7 +503,7 @@ can't be disabled for the main build. MRuby::CrossBuild.new('Minimal') do |conf| toolchain :gcc - conf.cc.defines = %w(MRB_DISABLE_STDIO) + conf.cc.defines = %w(MRB_NO_STDIO) conf.bins = [] end ``` diff --git a/doc/guides/mrbconf.md b/doc/guides/mrbconf.md index c95634604..8791a94ac 100644 --- a/doc/guides/mrbconf.md +++ b/doc/guides/mrbconf.md @@ -11,7 +11,7 @@ You can use mrbconfs with following ways: changes `struct` layout and cause memory access error when C and other language(e.g., C++) is mixed. ## stdio setting. -`MRB_DISABLE_STDIO` +`MRB_NO_STDIO` * When defined `<stdio.h>` functions won't be used. * Some features will be disabled when this is enabled: * `mrb_irep` load/dump from/to file. @@ -19,7 +19,7 @@ You can use mrbconfs with following ways: * Printing features in **src/print.c**. ## Debug macros. -`MRB_ENABLE_DEBUG_HOOK` +`MRB_USE_DEBUG_HOOK` * When defined code fetch hook and debug OP hook will be enabled. * When using any of the hook set function pointer `code_fetch_hook` and/or `debug_op_hook` of `mrb_state`. * Fetch hook will be called before any OP. @@ -176,6 +176,6 @@ largest value of required alignment. * No `MRB_USE_METHOD_T_STRUCT` requires highest 2 bits of function pointers to be zero * Define this macro on machines that use higher bits of pointers -`MRB_ENABLE_ALL_SYMBOLS` +`MRB_USE_ALL_SYMBOLS` * Make it available `Symbols.all_symbols` in `mrbgems/mruby-symbol-ext` * Increase heap memory usage. |