summaryrefslogtreecommitdiffhomepage
path: root/doc
diff options
context:
space:
mode:
authorYukihiro "Matz" Matsumoto <[email protected]>2020-10-31 19:44:26 +0900
committerYukihiro "Matz" Matsumoto <[email protected]>2020-11-02 15:14:35 +0900
commit70ee9363671ff5aead633807b9579dab22f94cf3 (patch)
treedc4f34cc7b651fae8044ea0471036fa9fdf1d5bd /doc
parentc4277769107cd0a49f4874fd538113fe7a686d19 (diff)
downloadmruby-70ee9363671ff5aead633807b9579dab22f94cf3.tar.gz
mruby-70ee9363671ff5aead633807b9579dab22f94cf3.zip
Update the build description in `mruby3.md`.
Diffstat (limited to 'doc')
-rw-r--r--doc/mruby3.md9
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/mruby3.md b/doc/mruby3.md
index 12cc78a1b..fdf21ed19 100644
--- a/doc/mruby3.md
+++ b/doc/mruby3.md
@@ -13,9 +13,12 @@ directory. For examples:
* `boxing`: compiles all three boxing options
* `clang-asan`: compiles with `clang`'s Address Sanitizer
-`build_config/${MRUBY_CONFIG}.rb` is used if the path specified
-in `MRUBY_CONFIG` doesn't exist, so you can specify it as
-`rake MRUBY_CONFIG=boxing`.
+You can specify the build configration file with the
+`MRUBY_CONFIG` environment variable (or `CONFIG` in short).
+If the value specified by `MRUBY_CONFIG` is not the path to
+the configuration file, `build_config/${MRUBY_CONFIG}.rb` is
+used. So you can specify it as `rake MRUBY_CONFIG=boxing`,
+for example.
# Build Configuration Contribution