1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
The Ruby Programming Language [mirror]
Find a file
eileencodes b91b3bc771 Add a cache for class variables
Redo of 34a2acdac7 and
931138b006 which were reverted.

GitHub PR #4340.

This change implements a cache for class variables. Previously there was
no cache for cvars. Cvar access is slow due to needing to travel all the
way up th ancestor tree before returning the cvar value. The deeper the
ancestor tree the slower cvar access will be.

The benefits of the cache are more visible with a higher number of
included modules due to the way Ruby looks up class variables. The
benchmark here includes 26 modules and shows with the cache, this branch
is 6.5x faster when accessing class variables.

```
compare-ruby: ruby 3.1.0dev (2021-03-15T06:22:34Z master 9e5105c) [x86_64-darwin19]
built-ruby: ruby 3.1.0dev (2021-03-15T12:12:44Z add-cache-for-clas.. c6be009) [x86_64-darwin19]

|         |compare-ruby|built-ruby|
|:--------|-----------:|---------:|
|vm_cvar  |      5.681M|   36.980M|
|         |           -|     6.51x|
```

Benchmark.ips calling `ActiveRecord::Base.logger` from within a Rails
application. ActiveRecord::Base.logger has 71 ancestors. The more
ancestors a tree has, the more clear the speed increase. IE if Base had
only one ancestor we'd see no improvement. This benchmark is run on a
vanilla Rails application.

Benchmark code:

```ruby
require "benchmark/ips"
require_relative "config/environment"

Benchmark.ips do |x|
  x.report "logger" do
    ActiveRecord::Base.logger
  end
end
```

Ruby 3.0 master / Rails 6.1:

```
Warming up --------------------------------------
              logger   155.251k i/100ms
Calculating -------------------------------------
```

Ruby 3.0 with cvar cache /  Rails 6.1:

```
Warming up --------------------------------------
              logger     1.546M i/100ms
Calculating -------------------------------------
              logger     14.857M (± 4.8%) i/s -     74.198M in   5.006202s
```

Lastly we ran a benchmark to demonstate the difference between master
and our cache when the number of modules increases. This benchmark
measures 1 ancestor, 30 ancestors, and 100 ancestors.

Ruby 3.0 master:

```
Warming up --------------------------------------
            1 module     1.231M i/100ms
          30 modules   432.020k i/100ms
         100 modules   145.399k i/100ms
Calculating -------------------------------------
            1 module     12.210M (± 2.1%) i/s -     61.553M in   5.043400s
          30 modules      4.354M (± 2.7%) i/s -     22.033M in   5.063839s
         100 modules      1.434M (± 2.9%) i/s -      7.270M in   5.072531s

Comparison:
            1 module: 12209958.3 i/s
          30 modules:  4354217.8 i/s - 2.80x  (± 0.00) slower
         100 modules:  1434447.3 i/s - 8.51x  (± 0.00) slower
```

Ruby 3.0 with cvar cache:

```
Warming up --------------------------------------
            1 module     1.641M i/100ms
          30 modules     1.655M i/100ms
         100 modules     1.620M i/100ms
Calculating -------------------------------------
            1 module     16.279M (± 3.8%) i/s -     82.038M in   5.046923s
          30 modules     15.891M (± 3.9%) i/s -     79.459M in   5.007958s
         100 modules     16.087M (± 3.6%) i/s -     81.005M in   5.041931s

Comparison:
            1 module: 16279458.0 i/s
         100 modules: 16087484.6 i/s - same-ish: difference falls within error
          30 modules: 15891406.2 i/s - same-ish: difference falls within error
```

Co-authored-by: Aaron Patterson <tenderlove@ruby-lang.org>
2021-06-18 10:02:44 -07:00
.github Fixed comments in cmd.exe script [ci skip] 2021-06-16 14:31:02 +09:00
basictest Raise RuntimeError for class variable overtaken in nonverbose mode 2020-06-18 08:21:29 -07:00
benchmark Add a cache for class variables 2021-06-18 10:02:44 -07:00
bin Remove binstubs which are generated by Gem::Installer now. 2021-02-14 14:09:08 +09:00
bootstraptest bootstraptest/test_ractor.rb: Skip an assertion on Travis arm64. 2021-05-25 12:38:05 +02:00
ccan [Doc] Fix a typo s/oher/other/ 2021-04-25 19:46:00 +12:00
coroutine Fix -Wundef warnings in coroutine/*/Context.h 2021-05-04 14:56:55 +02:00
coverage Fix Typo 2021-06-07 10:22:55 +09:00
cygwin Share variables defined in common GNUmakefile also in cygwin/mingw 2021-03-21 17:57:44 +09:00
defs Remove short options with argument [Bug #17870] 2021-05-21 10:34:28 +09:00
doc Add scheduler hook Addrinfo.getaddrinfo. (#4375) 2021-06-14 16:21:08 +12:00
enc dependency updates 2021-04-13 14:30:21 +09:00
ext Removed no longer used variables 2021-06-14 14:11:38 +09:00
gems Bump matrix version to 0.4.2 2021-06-18 19:13:36 +09:00
include Add a cache for class variables 2021-06-18 10:02:44 -07:00
internal Add a cache for class variables 2021-06-18 10:02:44 -07:00
lib [ruby/net-protocol] Get rid of __send__ 2021-06-16 22:23:46 +09:00
libexec Removed unused option on racc 2020-09-28 18:53:25 +09:00
man Man page: correct defaults for RUBY_THREAD_VM_STACK_SIZE 2021-04-20 19:26:15 -04:00
misc lldb_cruby.py: push non-flonum float to history [ci skip] 2021-06-04 09:24:57 +09:00
missing Removed missing/dup2.c 2021-05-10 15:59:23 +09:00
sample [Doc] Fix a typo s/interseting/interesting/ 2021-03-22 15:33:32 +09:00
spec Update to ruby/spec@c6e9285 2021-06-02 15:54:38 +02:00
template prelude.c.tmpl: strip comment-only or empty lines at the beginning 2021-06-06 22:45:37 +09:00
test ast.rb: RubyVM::AST.parse and .of accepts save_script_lines: true 2021-06-18 02:34:27 +09:00
tool Expose assert_all? for ruby/csv repo 2021-06-01 19:38:05 +09:00
win32 [Win32] fixed PACKED_STRUCT_UNALIGNED on x86 2021-06-09 18:49:14 +09:00
.dir-locals.el
.document Sort filenames [ci skip] 2021-01-15 12:29:39 +09:00
.editorconfig
.gdbinit .gdbinit: Fix indentation in print_id [ci skip] 2021-02-06 13:03:40 -05:00
.gitattributes
.gitignore Ignore static-ruby [ci skip] 2020-11-24 08:38:06 +09:00
.rspec_parallel
.travis.yml Enable Travis on the specific branches or forked repositories. 2021-06-09 17:16:53 +02:00
aclocal.m4 get rid of aclocal (#4280) 2021-03-17 18:52:53 +09:00
addr2line.c solaris/illumos build fix. 2021-03-22 22:51:15 +09:00
addr2line.h
appveyor.yml Get rid of updating Unicode files 2021-06-07 17:45:50 +09:00
array.c Adjust styles [ci skip] 2021-06-17 10:13:40 +09:00
array.rb array.rb: Remove unnecessary phrase from rdoc 2020-11-12 16:59:59 +09:00
ast.c Enable USE_ISEQ_NODE_ID by default 2021-06-18 03:35:38 +09:00
ast.rb ast.rb: RubyVM::AST.parse and .of accepts save_script_lines: true 2021-06-18 02:34:27 +09:00
autogen.sh autogen.sh: Make it work with sh (not bash) 2021-03-17 23:13:22 +09:00
bignum.c Remove unneeded declarations in bignum.c 2021-03-20 20:55:58 +09:00
BSDL
builtin.c Fix trivial -Wundef warnings 2021-05-04 14:56:55 +02:00
builtin.h Fix trivial -Wundef warnings 2021-05-04 14:56:55 +02:00
class.c Add a cache for class variables 2021-06-18 10:02:44 -07:00
common.mk Add a cache for class variables 2021-06-18 10:02:44 -07:00
compar.c Don't redefine #rb_intern over and over again 2020-10-21 12:45:18 +09:00
compile.c Add a cache for class variables 2021-06-18 10:02:44 -07:00
complex.c Rename nucomp_false s nucomp_real_p_m 2021-05-20 14:31:49 +09:00
configure.ac Configure ioctl request argument type [Bug #17759] 2021-06-16 13:17:19 +09:00
constant.h
cont.c cont.c: Replace "iff" with "if and only if" 2021-06-12 20:15:08 +09:00
CONTRIBUTING.md [Doc] Link to doc/contributing.rdoc from CONTRIBUTING.md (#4266) 2021-04-03 14:45:18 +09:00
COPYING
COPYING.ja
debug.c Revert "Enclose crtitical sections in thread_exclusive block" 2021-02-24 03:13:07 +09:00
debug_counter.c make RB_DEBUG_COUNTER_INC()_thread-safe 2020-12-17 03:43:59 +09:00
debug_counter.h Add a cache for class variables 2021-06-18 10:02:44 -07:00
dir.c dir.rb: moved class rdoc from dir.c 2021-06-07 20:44:05 +09:00
dir.rb [DOC] fix metacharacter markups [ci skip] 2021-06-07 20:44:05 +09:00
dln.c Protoized old pre-ANSI K&R style declarations and definitions 2021-05-07 00:04:36 +09:00
dln.h Removed dln_a_out 2021-03-24 20:13:55 +09:00
dln_find.c Removed an unused declaration 2021-03-12 19:28:17 +09:00
dmydln.c
dmyenc.c
dmyext.c
encindex.h
encoding.c rb_enc_interned_str: handle autoloaded encodings 2021-03-22 21:37:48 +09:00
enum.c Enhanced RDoc for Enumerable (#4479) 2021-05-10 14:00:36 -05:00
enumerator.c Adjust styles [ci skip] 2021-06-17 10:13:40 +09:00
error.c Fix example for custom warn method 2021-04-30 17:13:04 -07:00
eval.c Refactor rb_obj_call_init and rb_obj_call_init_kw (#4351) 2021-04-04 11:34:51 +09:00
eval_error.c Limit bactrace length from Exception#full_message 2020-12-27 20:50:15 +09:00
eval_intern.h Fix trivial -Wundef warnings 2021-05-04 14:56:55 +02:00
eval_jump.c Protoized old pre-ANSI K&R style declarations and definitions 2021-05-07 00:04:36 +09:00
file.c What's Here for class File (#4460) 2021-05-07 11:22:32 -05:00
gc.c Add a cache for class variables 2021-06-18 10:02:44 -07:00
gc.h Introduce Ractor mechanism for parallel execution 2020-09-03 21:11:06 +09:00
gc.rb Add documentation about GC.compact 2020-12-17 13:26:53 -08:00
gem_prelude.rb Removed needless .rb 2020-12-02 13:32:43 +09:00
golf_prelude.rb
goruby.c goruby_options: do not goto into a branch 2020-06-29 11:05:41 +09:00
GPL
hash.c Adjust styles [ci skip] 2021-06-17 10:13:40 +09:00
hrtime.h
id_table.c Add a cache for class variables 2021-06-18 10:02:44 -07:00
id_table.h
inits.c Implemented some NilClass method in Ruby code is faster [Feature #17054] (#3366) 2021-06-02 20:04:56 -07:00
insns.def Add a cache for class variables 2021-06-18 10:02:44 -07:00
internal.h RHASH_EMPTY_P: convert into an inline function 2020-08-19 15:10:53 +09:00
io.c Adjust styles [ci skip] 2021-06-17 10:13:40 +09:00
io.rb [Feature #16254] Use Primitive.func style 2020-06-19 18:46:55 +09:00
iseq.c Enable USE_ISEQ_NODE_ID by default 2021-06-18 03:35:38 +09:00
iseq.h Enable USE_ISEQ_NODE_ID by default 2021-06-18 03:35:38 +09:00
kernel.rb [DOC] Use URI#read instead of URI.open for better compatibility 2021-01-12 22:12:02 +09:00
KNOWNBUGS.rb Remove known use-after-poison bug 2020-10-03 00:45:06 +09:00
LEGAL Removed missing/dup2.c 2021-05-10 15:59:23 +09:00
lex.c.blt
load.c Suppress gcc11 clobbered warning 2021-06-14 23:24:17 +09:00
loadpath.c
localeinit.c win32: Use UTF-8 as filesystem encoding [Feature #12654] 2020-12-20 18:34:04 +09:00
main.c stdlib.h is always included in include/ruby/defines.h 2021-01-05 01:06:33 +09:00
marshal.c Remove unneeded declarations 2021-03-20 21:00:29 +09:00
math.c Fix Math.cbrt(0.0) on glibc 2021-05-08 14:45:30 -07:00
memory_view.c Adjust styles [ci skip] 2021-06-17 10:13:40 +09:00
method.h prohibi method call by defined_method in other racotrs 2020-09-25 20:37:38 +09:00
mini_builtin.c * expand tabs. [ci skip] 2021-06-17 06:09:26 +09:00
miniinit.c
mjit.c Cast jit_func for Windows 2021-06-10 00:40:59 -07:00
mjit.h Avoid enqueueing the same ISeq twice 2021-06-10 00:32:24 -07:00
mjit_compile.c Improve perfomance for Integer#size method [Feature #17135] (#3476) 2021-06-04 21:57:21 -07:00
mjit_worker.c Adjust styles [ci skip] 2021-06-17 10:13:40 +09:00
NEWS.md Note about 07c05b6fe9 2021-06-02 22:26:27 -07:00
nilclass.rb Implemented some NilClass method in Ruby code is faster [Feature #17054] (#3366) 2021-06-02 20:04:56 -07:00
node.c ast.rb: RubyVM::AST.parse and .of accepts save_script_lines: true 2021-06-18 02:34:27 +09:00
node.h node.h: Reduce struct size to fit with Ruby object size (five VALUEs) 2021-06-18 02:34:27 +09:00
numeric.c Improve perfomance for Integer#size method [Feature #17135] (#3476) 2021-06-04 21:57:21 -07:00
numeric.rb Improve perfomance for Integer#size method [Feature #17135] (#3476) 2021-06-04 21:57:21 -07:00
object.c Adjust styles [ci skip] 2021-06-17 10:13:40 +09:00
pack.c RARRAY_AREF: convert into an inline function 2020-08-15 12:09:26 +09:00
pack.rb [DOC] Fix grammar: "is same as" -> "is the same as" 2021-01-05 15:13:53 +01:00
parse.y node.h: Reduce struct size to fit with Ruby object size (five VALUEs) 2021-06-18 02:34:27 +09:00
prelude.rb Thread.exclusive: delete 2020-08-31 18:08:57 +09:00
probes.d remove method__cache__clear 2020-12-24 01:59:36 +09:00
probes_helper.h
proc.c Adjust styles [ci skip] 2021-06-17 10:13:40 +09:00
process.c Expose scheduler as public interface & bug fixes. (#3945) 2021-02-09 19:39:56 +13:00
ractor.c Enable VM_ASSERT in --jit CIs (#4543) 2021-06-01 00:15:51 -07:00
ractor.rb Fix some typos by spell checker 2021-04-26 10:07:41 +09:00
ractor_core.h Fix trivial -Wundef warnings 2021-05-04 14:56:55 +02:00
random.c Fix compilation errors in FreeBSD 2021-05-04 20:38:03 -04:00
range.c Use public allocators for creating new T_OBJECT objects 2020-10-28 18:35:22 -07:00
rational.c cdhash_cmp: can take rational literals 2021-05-12 10:30:46 +09:00
re.c Warn more duplicate literal hash keys 2021-06-03 15:11:18 +09:00
README.EXT
README.EXT.ja
README.ja.md [DOC] Update README [ci skip] 2021-03-17 23:55:03 +09:00
README.md Add section on build requirements to the README 2021-06-18 10:58:27 +09:00
regcomp.c Fixed shorten-64-to-32 errors when USE_COMBINATION_EXPLOSION_CHECK 2021-05-07 20:15:05 +09:00
regenc.c
regenc.h
regerror.c
regexec.c Fixed shorten-64-to-32 errors when USE_COMBINATION_EXPLOSION_CHECK 2021-05-07 20:15:05 +09:00
regint.h Enable arm64 optimizations that exist for power/x86 (#3393) 2020-08-14 02:15:54 +09:00
regparse.c Do not reduce quantifiers if it affects which text will be matched 2020-12-02 18:42:02 +01:00
regparse.h
regsyntax.c
ruby-runner.c
ruby.c Freeze command line script 2021-06-10 15:15:35 +09:00
ruby_assert.h Introduce Ractor mechanism for parallel execution 2020-09-03 21:11:06 +09:00
ruby_atomic.h Expose atomic operation macros with RUBY prefix 2020-12-24 11:43:21 +09:00
rubystub.c
scheduler.c Adjust styles [ci skip] 2021-06-17 10:13:40 +09:00
signal.c Fix -Wundef warnings for patterns #if HAVE 2021-05-04 14:56:55 +02:00
siphash.c Fix compilation error in mingw 2021-05-04 20:38:03 -04:00
siphash.h
sparc.c
sprintf.c sprintf.c: Removed conflicting definition 2020-09-28 12:51:53 +09:00
st.c Adjust styles [ci skip] 2021-06-17 10:13:40 +09:00
strftime.c Fix -Wundef warnings for patterns #if HAVE 2021-05-04 14:56:55 +02:00
string.c Adjust styles [ci skip] 2021-06-17 10:13:40 +09:00
struct.c Warn Struct#initialize with only keyword args (#4070) 2021-01-17 01:35:54 -08:00
symbol.c rb_enc_symname_type: indent 2021-03-05 16:33:29 +09:00
symbol.h include/ruby/backward/2/r_cast.h: deprecate 2020-08-27 15:03:36 +09:00
thread.c Adjust styles [ci skip] 2021-06-17 10:13:40 +09:00
thread_pthread.c POSIX timer cannot be shared in forked process [Bug #17941] 2021-06-09 12:32:18 +09:00
thread_pthread.h Protoized old pre-ANSI K&R style declarations and definitions 2021-05-07 00:04:36 +09:00
thread_sync.c Adjust styles [ci skip] 2021-06-17 10:13:40 +09:00
thread_win32.c Make Thread#native_thread_id not-implemented if unsupported 2021-06-01 22:27:13 +09:00
thread_win32.h fix public interface 2020-11-18 03:52:41 +09:00
time.c Make frozen Time Ractor-shareable 2021-06-18 11:58:15 +09:00
timev.h
timev.rb timev.rb: moved class rdoc from time.c 2021-06-07 20:44:05 +09:00
trace_point.rb Document binding behavior for C call/return events for TracePoint/set_trace_func 2021-04-26 15:21:52 -07:00
transcode.c Fix some typos by spell checker 2021-04-26 10:07:41 +09:00
transcode_data.h
transient_heap.c cancel theap on multi-ractors 2020-12-07 08:28:36 +09:00
transient_heap.h cancel theap on multi-ractors 2020-12-07 08:28:36 +09:00
util.c Get rid of misleading indentation 2021-05-03 11:17:14 +12:00
variable.c Add a cache for class variables 2021-06-18 10:02:44 -07:00
variable.h fix ivar with shareable objects issue 2020-12-12 06:19:18 +09:00
version.c
version.h * 2021-06-18 [ci skip] 2021-06-18 02:34:45 +09:00
vm.c Add a cache for class variables 2021-06-18 10:02:44 -07:00
vm_args.c remove unused decl 2021-01-08 14:39:05 +09:00
vm_backtrace.c Enable USE_ISEQ_NODE_ID by default 2021-06-18 03:35:38 +09:00
vm_callinfo.h global call-cache cache table for rb_funcall* 2021-01-29 16:22:12 +09:00
vm_core.h Add a cache for class variables 2021-06-18 10:02:44 -07:00
vm_debug.h support multiple filters by RUBY_DEBUG_LOG_FILTER 2020-08-02 04:24:47 +09:00
vm_dump.c Crash more nicely when the VM isn't fully set up 2021-06-10 16:31:29 -07:00
vm_eval.c Refactor rb_block_call function 2021-06-13 13:44:46 +09:00
vm_exec.c Fix trivial -Wundef warnings 2021-05-04 14:56:55 +02:00
vm_exec.h RUBY_CONST_ASSERT: use STATIC_ASSERT instead 2020-07-10 12:23:41 +09:00
vm_insnhelper.c Add a cache for class variables 2021-06-18 10:02:44 -07:00
vm_insnhelper.h Add a cache for class variables 2021-06-18 10:02:44 -07:00
vm_method.c Adjust styles [ci skip] 2021-06-17 10:13:40 +09:00
vm_opts.h
vm_sync.c Fixed leaked global symbols 2020-12-26 09:39:53 +09:00
vm_sync.h Adjusted indent [ci skip] 2021-02-09 08:41:06 +09:00
vm_trace.c Adjust styles [ci skip] 2021-06-17 10:13:40 +09:00
vsnprintf.c Protoized old pre-ANSI K&R style declarations and definitions 2021-05-07 00:04:36 +09:00
warning.rb Use category: :deprecated in warnings that are related to deprecation 2020-12-18 09:54:11 -08:00

Actions Status: macOS Actions Status: MinGW Actions Status: MJIT Actions Status: Ubuntu Actions Status: Windows AppVeyor status Travis Status

What's Ruby

Ruby is an interpreted object-oriented programming language often used for web development. It also offers many scripting features to process plain text and serialized files, or manage system tasks. It is simple, straightforward, and extensible.

Features of Ruby

  • Simple Syntax
  • Normal Object-oriented Features (e.g. class, method calls)
  • Advanced Object-oriented Features (e.g. mix-in, singleton-method)
  • Operator Overloading
  • Exception Handling
  • Iterators and Closures
  • Garbage Collection
  • Dynamic Loading of Object Files (on some architectures)
  • Highly Portable (works on many Unix-like/POSIX compatible platforms as well as Windows, macOS, etc.) cf. https://github.com/ruby/ruby/blob/master/doc/contributing.rdoc#label-Platform+Maintainers

How to get Ruby

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

https://www.ruby-lang.org/en/downloads/

Git

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

$ git clone https://github.com/ruby/ruby.git

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

$ git ls-remote https://github.com/ruby/ruby.git

You may also want to use https://git.ruby-lang.org/ruby.git (actual master of Ruby source) if you are a committer.

Subversion

Stable branches for older Ruby versions can be checked out with also the following command:

$ svn co https://svn.ruby-lang.org/repos/ruby/branches/ruby_2_6/ ruby

Try the following command to see the list of branches:

$ svn ls https://svn.ruby-lang.org/repos/ruby/branches/

Ruby home page

https://www.ruby-lang.org/

Mailing list

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

subscribe

in the mail body (not subject) to the address ruby-talk-request@ruby-lang.org.

Requirements to build from repository

  1. GNU or BSD make
  2. C99 compiler
  3. autoconf 2.67 or higher
  4. automake 1.15 or higher
  5. bison 2.3 or higher
  6. Ruby 2.2 or higher

When building from a released version, only a C99 compiler and GNU or BSD make is required.

How to compile and install

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

  2. Run ./autogen.sh to generate configure, when you build the source checked out from the Git repository.

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

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

  4. Edit include/ruby/defines.h if you need. Usually this step will not be needed.

  5. Optional: Remove comment mark(#) before the module names from ext/Setup.

    This step is only necessary if you want to link modules statically.

    If you don't want to compile dynamic extensions (probably on architectures which do not allow dynamic loading), remove comment mark from the line "#option nodynamic" in ext/Setup.

    Usually this step will not be needed.

  6. Run make.

    • On Mac, set RUBY_CODESIGN environment variable with a signing identity. It uses the identity to sign ruby binary. See also codesign(1).
  7. Optionally, run 'make check' to check whether the compiled Ruby interpreter works well. If you see the message "check succeeded", your Ruby works as it should (hopefully).

  8. Run 'make install'.

    This command will create the following directories and install files into them.

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

    If Ruby's API version is 'x.y.z', the ${MAJOR} is 'x', the ${MINOR} is 'y', and the ${TEENY} 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 'make distclean-ext' 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 (https://www.ruby-lang.org/en/community/mailing-lists) or on websites like (https://stackoverflow.com).

Bugs should be reported at https://bugs.ruby-lang.org. Read HowToReport for more information.

Contributing

See the file CONTRIBUTING.md

The Author

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

matz@ruby-lang.org