Skip to content


Subversion checkout URL

You can clone with
Download ZIP
The Ruby Programming Language
Ruby C Emacs Lisp Tcl Objective-C Ragel in Ruby Host Other
Branch: trunk
Pull request Compare This branch is 8411 commits behind ruby:trunk.

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin irb: dead code
bootstraptest parse.y: parse precisely
cygwin * cygwin/ ( link *.res.o.
defs Set mode for GNU Makefile.
doc * doc/syntax/literals.rdoc: [DOC] String literal concat by @cknadler
enc Revert r41786 "broken utf-8"
ext * ext/dbm/extconf.rb: [DOC] Hide from RDoc
include * include/ruby/encoding.h: Reduce ENCODING_INLINE_MAX to 127 as this
lib * lib/yaml/dbm.rb: [DOC] Document call-seq for YAML::DBM
man * man/ri.1: Incorrect use of .Dd macro [Bug #8620] by Tristan Hill
misc * misc/ruby-electric.el (ruby-electric-delete-backward-char): Use
missing fix typos. Patch by k_takata.
nacl fix typos. Patch by k_takata.
sample * ext/curses/curses.c: [DOC] Update location of samples
spec * spec/default.mspec: expand relative path for ruby_exe which uses
symbian Added HAVE_LABS and HAVE_LLABS to config.h
template * template/encdb.h.tmpl: define encoding index macros to use the index
test random.c: coerce before check negative
tool * tool/make-snapshot: Fix order of priority for option parameter.
.document * .document: Removed extra space
.editorconfig .editorconfig: new
.gdbinit .gdbinit: initialize color sequences
.gitignore Ignore tool/config.guess and tool/config.sub * added for ruby-style.
COPYING * COPYING: change Ruby's License from a dual license with GPLv2
COPYING.ja Change encoding from EUC-JP to UTF-8. [Feature #5128]
ChangeLog random.c: coerce before check negative
KNOWNBUGS.rb * test/ruby/test_method.rb (test_unlinked_method_entry_in_method_obje…
LEGAL * util.c, include/ruby/util.h (ruby_add_suffix): remove the function.
NEWS * NEWS (REXML::Parsers::SAX2Parser): Add about this change.
README.EXT.ja * README.EXT, README.EXT.ja: Mention rb_integer_pack and
README.ja Fix the mail address of Matz; does not exist.
addr2line.h * addr2line.c: use USE_ELF instead of __ELF__ because Solaris
array.c * array.c (rb_ary_zip): performance implement by using
bignum.c * bignum.c (bitsize): Fix a conditional expression.
class.c * class.c (rb_prepend_module): make T_ICLASS object shady because install arch
compar.c * compar.c (Comparable#==): fix typo.
compile.c * compile.c (iseq_set_arguments): use RARRAY_RAWPTR() instead of
complex.c * gc.c: support RGENGC. [ruby-trunk - Feature #8339] * process.c (rb_clock_gettime): New method.
constant.h * class.c, include/ruby/ruby.h: add write barriers for T_CLASS,
cont.c * cont.c (rb_fiber_start): use RARRAY_RAWPTR() instead of
debug.c * safe.c (rb_set_safe_level, safe_setter): raise an ArgumentError
dln.c adjust style.
dln_find.c dln.c: extra arguments
dmyext.c no K&R style
encoding.c encoding.c: is_obj_encoding
enum.c internal.h: STATIC_ASSERT
error.c error.c: evaluate RARRAY_AREF once
eval.c * eval.c (rb_mod_refine, mod_using, top_using): don't show
eval_intern.h vm_core.h: move jmpbuf between tag and prev
eval_jump.c volatile errinfo
file.c file.c: OSX path encoding
gc.c * gc.c (gc_marks_test): inhibit gc for st's operation.
gc.h * gc.h (SET_MACHINE_STACK_END): Add !defined(_ILP32) to a defining
golf_prelude.rb cancel subversion backfire. sorry
goruby.c goruby.c: IRB at end
hash.c * hash.c (rb_hash_compare_by_id): add function prototype.
ia64.s * removed trailing spaces.
inits.c sizes.c: RbConfig::SIZEOF
iseq.h * include/ruby/ruby.h (struct rb_data_type_struct), gc.c: add
lex.c.blt * defs/keywords (reserved_word): made inline function static.
load.c load.c: search in OS path encoding
loadpath.c * loadpath.c (RUBY_REVISION): Defined to suppress revision.h
main.c * include/ruby/debug.h: introdudced.
marshal.c * bignum.c (MSB): Removed.
math.c * internal.h (numberof): Gathered from various files.
method.h * class.c, include/ruby/ruby.h: add write barriers for T_CLASS,
miniinit.c localeinit.c: split
node.c * include/ruby/util.h: removed extra semicolon in definition of
node.h parse.y, vm_eval.c: file encoding in eval
numeric.c * numeric.c: [DOC] fix typo.
object.c object.c: undef Module#prepend_features on Class
pack.c * internal.h (ruby_digit36_to_number_table): Declared.
parse.y parse.y: CR in middle
prelude.rb * prelude.rb: Moved Mutex#synchronize to
probes.d gen_dummy_probes.rb
probes_helper.h probes_helper.h: RUBY_DTRACE_HOOK
process.c * process.c: [DOC] RDoc formatting of Process.clock_gettime
random.c random.c: coerce before check negative
range.c range.c: revert r42400
rational.c * rational.c (rb_flt_rationalize_with_prec): new public C function
re.c re.c: suppress warning
regcomp.c * regcomp.c (): Merge Onigmo 5.13.5 23b523076d6f1161.
regenc.h defines.h: RUBY_SYMBOL_EXPORT_{BEGIN,END}
regerror.c * regcomp.c: Merge Onigmo 3d855b30d574536d3ae600260208c6624ae4791c.
regint.h * Merge Onigmo 5.13.4 f22cf2e566712cace60d17f84d63119d7c5764ee.
regparse.c * Merge Onigmo 5.13.4 f22cf2e566712cace60d17f84d63119d7c5764ee.
regparse.h defines.h: RUBY_SYMBOL_EXPORT_{BEGIN,END}
regsyntax.c * Merge Onigmo-5.13.1. [ruby-dev:45057] [Feature #5820]
ruby.c ruby.c: use String path version parser functions
ruby_atomic.h ruby_atomic.h: ATOMIC_CAS on VC6
safe.c safe.c: ruby_safe_level_4_warning
siphash.h * siphash.h: check configure macros before include newer headers.
sizes.c * sizes.c (Init_sizes): Define sizes only if the type actually exists.
sparc.c * sparc.c: Use __asm__ instead of asm for gcc.
st.c * st.c (st_locale_insensitive_strcasecmp): Renamed from st_strcasecmp.
strftime.c * strftime.c (rb_strftime_with_timespec): Test yday range.
struct.c struct.c: rb_struct_define_under
thread.c * thread.c (rb_threadptr_pending_interrupt_check_mask):
thread_native.h * thread_native.h: add rb_nativethread_self() which returns
thread_pthread.c * thread_(pthread|win32).h: rename rb_thread_cond_t to
thread_pthread.h * thread_(pthread|win32).h: rename rb_thread_cond_t to
thread_win32.c * thread_(pthread|win32).h: rename rb_thread_cond_t to
timev.h timev.h: move time_t stuffs
variable.c * include/ruby/ruby.h (OBJ_WRITE): cast to (VALUE *) for second
version.c loadpath.c: split
version.h * 2013-08-13
vm.c * proc.c: add Binding#local_variable_get/set/defined?
vm_backtrace.c * vm_backtrace.c: Update rdoc for Backtrace#label with @_ko1
vm_core.h * proc.c: add Binding#local_variable_get/set/defined?
vm_dump.c * vm_dump.c (rb_vm_bugreport): show name of class and module.
vm_eval.c * vm_insnhelper.c (vm_push_frame): fix stack overflow check codes.
vm_exec.h vm_exec.h: fix CHECK_VM_STACK_OVERFLOW_FOR_INSN
vm_insnhelper.c * vm_insnhelper.c (vm_invoke_block): returning from lambda proc
vm_opts.h fix minor code comment typos
vm_trace.c * vm_trace.c: [DOC] Fix TracePoint return values in examples
vsnprintf.c unecessary macros and K&R style coding


= What's Ruby

Ruby is the interpreted scripting language for quick and
easy object-oriented programming.  It has many features to
process text files and to do system management tasks (as in
Perl).  It is simple, straight-forward, and extensible.

== Features of Ruby

*   Simple Syntax
*   *Normal* Object-Oriented features(ex. class, method calls)
*   *Advanced* Object-Oriented features(ex. Mix-in, Singleton-method)
*   Operator Overloading
*   Exception Handling
*   Iterators and Closures
*   Garbage Collection
*   Dynamic Loading of Object files(on some architecture)
*   Highly Portable (works on many Unix-like/POSIX compatible platforms
    as well as Windows, Mac OS X, BeOS etc.)

== How to get Ruby

For a complete list of ways to install Ruby, including using third party
tools like rvm, see:

The Ruby distribution files can be found in the following FTP site:

The trunk of the Ruby source tree can be checked out with the
following command:

  $ svn co ruby

Or if you are using git then use the following command:

  $ git clone git://

There are some other branches under development.  Try the following
command and see the list of branches:

  $ svn ls

Or if you are using git then use the following command:

  $ git ls-remote git://

== Ruby home-page

The URL of the Ruby home-page is:

== Mailing list

There is a mailing list to talk about Ruby.
To subscribe this list, please send the following phrase

        subscribe YourFirstName YourFamilyName
        subscribe Joseph Smith

in the mail body (not subject) to the address <>.

== How to compile and install

This is what you need to do to compile and install Ruby:

0.   If you want to use Microsoft Visual C++ to compile ruby,
     read win32/README.win32 instead of this document.

1.   If +./configure+ does not exist or is older than,
     run autoconf to (re)generate configure.

2.   Run +./configure+, which will generate config.h and Makefile.

     Some C compiler flags may be added by default depending on your
     environment.  Specify <tt>optflags=..</tt> and <tt>warnflags=..</tt> as
     necessary to override them.

3.   Edit +defines.h+ if you need. Usually this step will not be needed.

4.   Remove comment mark(<tt>#</tt>) before the module names from +ext/Setup+
     (or add module names if not present), if you want to link modules

     If you don't want to compile non static extension modules
     (probably on architectures which does not allow dynamic loading),
     remove comment mark from the line "<tt>#option nodynamic</tt>" in

     Usually this step will not be needed.

5.   Run +make+.

6.   Optionally, run '<tt>make check</tt>' to check whether the compiled Ruby
     interpreter works well. If you see the message "<tt>check succeeded</tt>",
     your ruby works as it should (hopefully).

7.   Run '<tt>make install</tt>'

     This command will create following directories and install files
     onto them.

     * <tt>${DESTDIR}${prefix}/bin</tt>
     * <tt>${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}</tt>
     * <tt>${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}</tt>
     * <tt>${DESTDIR}${prefix}/lib</tt>
     * <tt>${DESTDIR}${prefix}/lib/ruby</tt>
     * <tt>${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}</tt>
     * <tt>${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}</tt>
     * <tt>${DESTDIR}${prefix}/lib/ruby/site_ruby</tt>
     * <tt>${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}</tt>
     * <tt>${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}</tt>
     * <tt>${DESTDIR}${prefix}/lib/ruby/vendor_ruby</tt>
     * <tt>${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}</tt>
     * <tt>${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}</tt>
     * <tt>${DESTDIR}${prefix}/lib/ruby/gems/${MAJOR}.${MINOR}.${TEENY}</tt>
     * <tt>${DESTDIR}${prefix}/share/man/man1</tt>
     * <tt>${DESTDIR}${prefix}/share/ri/${MAJOR}.${MINOR}.${TEENY}/system</tt>

     If Ruby's API version is '_x.y.z_', the <tt>${MAJOR}</tt> is '_x_', the
     <tt>${MINOR}</tt> is '_y_', and the <tt>${TEENY}</tt> is '_z_'.

     *NOTE*: teeny of the API version may be different from one of
     Ruby's program version

     You may have to be a super user to install ruby.

If you fail to compile ruby, please send the detailed error report with
the error log and machine/OS type, to help others.

Some extension libraries may not get compiled because of lack of
necessary external libraries and/or headers, then you will need to run
'<tt>make distclean-ext</tt>' to remove old configuration after
installing them in such case.

== Copying

See the file +COPYING+.

== Feedback

Questions about the Ruby language can be asked on the Ruby-Talk mailing list
( or on websites like

Bug reports should be filed at

== The Author

Ruby was originally designed and developed by Yukihiro Matsumoto (Matz) in 1995.


Local variables:
mode: rdoc
Something went wrong with that request. Please try again.