From 81c21088196fd92d08c253efc2feb8dbead88acf Mon Sep 17 00:00:00 2001 From: KOBAYASHI Shuji Date: Mon, 19 Oct 2020 15:03:22 +0900 Subject: Revert `MRUBY_TARGET` mechanism; ref #5096 * In explanation of mruby, the expression `build_config.rb` is frequently used including official documents, so I think that it will not make sense if the file is no longer used. * The `MRUBY_TARGET` mechanism seems to have little improvement, so I don't think it should be changed to avoid unnecessary confusion. * `MRUBY_TARGET` and `MRuby.targets` represent somewhat different things, so using the same term "target" is a bit confusing. The mechanism that can be written short when using a file under `build_config` (renamed from `target`) directory remains (`build_config/${MRUBY_CONFIG}.rb` is used if the path specified in `MRUBY_CONFIG` doesn't exist). --- doc/mruby3.md | 32 ++++++++------------------------ 1 file changed, 8 insertions(+), 24 deletions(-) (limited to 'doc/mruby3.md') diff --git a/doc/mruby3.md b/doc/mruby3.md index 029c9887e..e611a1b16 100644 --- a/doc/mruby3.md +++ b/doc/mruby3.md @@ -3,45 +3,29 @@ User visible changes in `mruby3` # Build System -You can specify `TARGET` option to `rake` via a command line -option, or via an environment variable, e.g. - -`rake TARGET=host all` - -or - -`TARGET=host rake all` - -It's much easier to switch multiple targets than the -previous `build_config.rb` system. - ## `presym` target The first compilation of `mruby` may require generation of a static symbol table named `build/presym`. You can generate the table by `rake gensym`. -## `target` directory +## `build_config` directory -Build target specification files are loaded from `target` -directory. The default `TARGET` is `host` which is described -in `target/host.rb`. There are many other targets for example: +Typical build configuration files are located in `build_config` +directory. For examples: * `host-gprof`: compiles with `gprof` for performance tuning * `host-m32`: compiles in gcc 32bit mode on 64bit platforms * `boxing`: compiles all three boxing options * `clang-asan`: compiles with `clang`'s Address Sanitizer -`target/host.rb` comes with comments to help writing a new -target description. - -If you want to have your target description out of the -source tree, you can specify the path to the description -file in `MRUBY_CONFIG`. +`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`. -# Build Target Contribution +# Build Configuration Contribution -When you write a new target description, please +When you write a new build configuration description, please contribute. We welcome your contribution as a GitHub pull-request. -- cgit v1.2.3