path: root/README.EXT
diff options
authoreban <eban@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2004-11-01 10:41:08 +0000
committereban <eban@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2004-11-01 10:41:08 +0000
commit0aeea1ad38b6e033fd18ed1594c4fa4404710e53 (patch)
tree03e984da4ffd90b5039718ffe8c65b6b80c34c66 /README.EXT
parent49fb289ea1a328c5b680fe718589a3532183b747 (diff)
git-svn-id: svn+ssh:// b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'README.EXT')
1 files changed, 8 insertions, 25 deletions
diff --git a/README.EXT b/README.EXT
index c65c177..d832d1e 100644
@@ -460,19 +460,11 @@ directory in the Ruby's source tree.
Make a directory for the extension library under ext directory.
-(2) create MANIFEST file
- % cd ext/dbm
- % touch MANIFEST
-There should be MANIFEST file in the directory for the extension
-library. Make an empty file for now.
-(3) design the library
+(2) design the library
You need to design the library features, before making it.
-(4) write C code.
+(3) write C code.
You need to write C code for your extension library. If your library
has only one source file, choosing ``LIBRARY.c'' as a file name is
@@ -600,7 +592,7 @@ are not exported to the Ruby world. You need to protect them by
void rb_global_variable(VALUE *var)
-(5) prepare extconf.rb
+(4) prepare extconf.rb
If the file named extconf.rb exists, it will be executed to generate
Makefile. If not, the compilation scheme will try to generate Makefile
@@ -628,7 +620,7 @@ If a compilation condition is not fulfilled, you should not call
``create_makefile''. The Makefile will not generated, compilation will
not be done.
-(6) prepare depend (optional)
+(5) prepare depend (optional)
If the file named depend exists, Makefile will include that file to
check dependencies. You can make this file by invoking
@@ -637,16 +629,7 @@ check dependencies. You can make this file by invoking
It's no harm. Prepare it.
-(7) put file names into MANIFEST (optional)
- % find * -type f -print > MANIFEST
-Append file names into MANIFEST. The compilation scheme requires
-MANIFEST only to exist, but it's better to take this step in order
-to distinguish which files are required.
-(8) generate Makefile
+(6) generate Makefile
Try generating the Makefile by:
@@ -656,7 +639,7 @@ You don't need this step if you put the extension library under the ext
directory of the ruby source tree. In that case, compilation of the
interpreter will do this step for you.
-(9) make
+(7) make
@@ -665,13 +648,13 @@ Type
to compile your extension. You don't need this step either if you have
put extension library under the ext directory of the ruby source tree.
-(9) debug
+(8) debug
You may need to rb_debug the extension. Extensions can be linked
statically by the adding directory name in the ext/Setup file so that
you can inspect the extension with the debugger.
-(10) done, now you have the extension library
+(9) done, now you have the extension library
You can do anything you want with your library. The author of Ruby
will not claim any restrictions on your code depending on the Ruby API.