1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
ruby--ruby/spec/rubyspec/optional/capi/README
eregon 95e8c48dd3 Add in-tree mspec and ruby/spec
* For easier modifications of ruby/spec by MRI developers.
* .gitignore: track changes under spec.
* spec/mspec, spec/rubyspec: add in-tree mspec and ruby/spec.
  These files can therefore be updated like any other file in MRI.
  Instructions are provided in spec/README.
  [Feature #13156] [ruby-core:79246]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@58595 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2017-05-07 12:04:49 +00:00

16 lines
689 B
Text

C-API Specs
These specs test the C-API from Ruby. The following are conventions for the
specs:
1. Put specs for functions related to a Ruby class in a file named according
to the class. For example, for rb_ary_new function, put the specs in
optional/capi/array_spec.rb
2. Put the C file containing the C functions for array_spec.rb in
optional/capi/ext/array_spec.c
3. Add a '#define HAVE_RB_ARY_NEW 1' to rubyspec.h
4. Name the C extension class 'CApiArraySpecs'.
5. Name the C functions 'array_spec_rb_ary_new'.
6. Wrap the code in the optional/capi/ext/array_spec.c in
'#ifdef HAVE_RB_ARY_NEW'
6. Attach the C function to the class using the name 'rb_ary_new'