summaryrefslogtreecommitdiffhomepage
path: root/doc/compile
diff options
context:
space:
mode:
authorDaniel Bovensiepen <[email protected]>2013-05-08 21:54:51 +0800
committerDaniel Bovensiepen <[email protected]>2013-05-08 21:54:51 +0800
commit2991c8b0b22bc19f6137b2468fa6daaedca87a7b (patch)
tree58b08ffaede57b42b131054d2d0eff140f042bb5 /doc/compile
parent8e45630896af83ad9ad938ef135f51cfe35f885e (diff)
downloadmruby-2991c8b0b22bc19f6137b2468fa6daaedca87a7b.tar.gz
mruby-2991c8b0b22bc19f6137b2468fa6daaedca87a7b.zip
[doc] Add minimal build configuration
In relation to #1225. Adds a minimal build configuration for libmruby which contains as less as possible.
Diffstat (limited to 'doc/compile')
-rw-r--r--doc/compile/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/compile/README.md b/doc/compile/README.md
index 231f8995c..a244d06b2 100644
--- a/doc/compile/README.md
+++ b/doc/compile/README.md
@@ -346,6 +346,25 @@ linking with *build/i386/lib/libmruby_core.a*
----------------------------------------------------------------
```
+## Build Configuration Examples
+
+### Minimal Library
+
+To build a minimal mruby library you need to use the Cross Compiling
+feature due to the reason that there are functions (i.e. stdio) which
+can't be disabled for the main build.
+
+ MRuby::CrossBuild.new('Minimal') do |conf|
+ toolchain :gcc
+
+ conf.cc.defines = %w(DISABLE_STDIO)
+ conf.bins = []
+ end
+
+This configuration defines a cross compile build called 'Minimal' which
+is using the GCC and compiles for the host machine. It also disables
+all usages of stdio and doesn't compile any binaries (i.e. mrbc).
+
## Test Environment
mruby's build process includes a test environment. In case you start the testing