Commit 4e5315ff authored by Masaki Muranaka's avatar Masaki Muranaka

Add more info about "include_paths and GEM dependency".

parent 7b6150ab
...@@ -75,6 +75,8 @@ contains every gem found in the *mrbgems* directory. ...@@ -75,6 +75,8 @@ contains every gem found in the *mrbgems* directory.
The maximal GEM structure looks like this: The maximal GEM structure looks like this:
+- GEM_NAME <- Name of GEM +- GEM_NAME <- Name of GEM
|
+- include/ <- Header for Ruby extension (will exported)
| |
+- mrblib/ <- Source for Ruby extension +- mrblib/ <- Source for Ruby extension
| |
...@@ -87,10 +89,10 @@ The maximal GEM structure looks like this: ...@@ -87,10 +89,10 @@ The maximal GEM structure looks like this:
+- README.md <- Readme for GEM +- README.md <- Readme for GEM
The folder *mrblib* contains pure Ruby files to extend mruby. The folder *src* The folder *mrblib* contains pure Ruby files to extend mruby. The folder *src*
contains C files to extend mruby. The folder *test* contains C and pure Ruby files contains C/C++ files to extend mruby. The folder *include* contains C/C++ header
for testing purposes which will be used by `mrbtest`. *mrbgem.rake* contains files. The folder *test* contains C/C++ and pure Ruby files for testing purposes
the specification to compile C and Ruby files. *README.md* is a short description which will be used by `mrbtest`. *mrbgem.rake* contains the specification
of your GEM. to compile C and Ruby files. *README.md* is a short description of your GEM.
## Build process ## Build process
...@@ -173,6 +175,19 @@ the following options additionally inside of your GEM specification: ...@@ -173,6 +175,19 @@ the following options additionally inside of your GEM specification:
* `spec.test_objs` (Object test files for integration into mrbtest) * `spec.test_objs` (Object test files for integration into mrbtest)
* `spec.test_preload` (Initialization files for mrbtest) * `spec.test_preload` (Initialization files for mrbtest)
### include_paths and depencency
Your GEM can export include paths to another GEMs that depends on your GEM.
By default, `/...absolute path.../{GEM_NAME}/include` will be exported.
So it is recommended not to put GEM's local header files on include/.
These exports are retroactive.
For example: when B depends to C and A depends to B, A will get include paths exported by C.
Exported include_paths are automatically appended to GEM local include_paths by Minirake.
You can use `spec.export_include_paths` accessor if you want more complex build.
## C Extension ## C Extension
mruby can be extended with C. This is possible by using the C API to mruby can be extended with C. This is possible by using the C API to
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment