summaryrefslogtreecommitdiff
path: root/spec/ruby/optional/capi/README
blob: 069ca3c106cacbcae4e1f6ee3658904060e09eda (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
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.  Name the C extension class 'CApiArraySpecs'.
4.  Name the C functions 'array_spec_rb_ary_new'.
5.  Attach the C function to the class using the name 'rb_ary_new'