summaryrefslogtreecommitdiff
path: root/jni/ruby/spec/README
diff options
context:
space:
mode:
Diffstat (limited to 'jni/ruby/spec/README')
-rw-r--r--jni/ruby/spec/README31
1 files changed, 31 insertions, 0 deletions
diff --git a/jni/ruby/spec/README b/jni/ruby/spec/README
new file mode 100644
index 0000000..9821404
--- /dev/null
+++ b/jni/ruby/spec/README
@@ -0,0 +1,31 @@
+= RubySpec
+
+RubySpec (http://rubyspec.org) provides the annotation of the Ruby
+implementation in an executable format. The make task
+`update-rubyspec' retrieves the specification and puts it into this
+directory.
+
+== Directory structure
+ spec
+ +-- mspec driver library for executing the specification.
+ +-- rubyspec
+ +-- core specification for core libraries
+ | +-- array
+ | +-- bignum
+ | +-- ...
+ |
+ +-- fixtures example classes for writing specs
+ +-- language specification for Ruby language itself
+ +-- library specification for standard libraries
+ +-- addrev
+ +-- ...
+
+== How to run
+:make target
+ verifies all specs.
+ $ make test-rubyspec
+:mspec command
+ verifies the specified spec.
+ $ mspec {language|core|library}
+ or
+ $ mspec spec/path/to/some_spec.rb