development fork of ruby/ruby
Перейти к файлу
Yusuke Endoh 08137c5dd9 [ruby/rdoc] Optimize RawLine by using a regexp instead of negative look-ahead rule
This improves the performance in some cases.
`rdoc .../gems/sinatra-2.1.0/README.md` takes 10.5 sec. before this
change, and 7.1 sec. after this change.
`make rdoc` of ruby/ruby takes 19.3 sec. before this change, 18.1 sec.
after this change.

https://github.com/ruby/rdoc/commit/7cf8281e3e
2022-02-12 14:59:26 +09:00
.github LLVM 15 begun. 2022-02-10 08:24:18 +09:00
basictest [wasm] bootstraptest, basictest: disable backquote literal tests 2022-01-19 11:19:06 +09:00
benchmark Speed up and avoid kwarg hash alloc in Time.now 2022-01-12 12:55:14 -08:00
bin Remove probably unintented symlinks 2021-07-27 18:49:28 +09:00
bootstraptest support concurrent btest execution 2022-02-06 03:05:47 +09:00
ccan [Doc] Fix a typo s/oher/other/ 2021-04-25 19:46:00 +12:00
coroutine [wasm] add coroutine/asyncify implementation 2022-01-19 11:19:06 +09:00
coverage Fix Typo 2021-06-07 10:22:55 +09:00
cygwin Suppress maybe-uninitialized warning on mingw 2021-10-02 08:02:57 +09:00
defs Add a Module#const_added callback 2022-01-14 11:30:07 +01:00
doc [DOC] Prefer the original file names over generated names 2022-02-09 15:31:10 +09:00
enc Update dependencies 2021-11-21 16:21:18 +09:00
ext objspace: Hide identhash containing internal objs 2022-02-09 17:32:43 -08:00
gems Update RBS (#5515) 2022-02-02 13:25:47 +09:00
include Mark `rb_clear_constant_cache` as internal use only 2022-01-20 13:54:37 +09:00
internal Mark `rb_clear_constant_cache` as internal use only 2022-01-20 13:54:37 +09:00
lib [ruby/rdoc] Optimize RawLine by using a regexp instead of negative look-ahead rule 2022-02-12 14:59:26 +09:00
libexec [ruby/irb] require_relative can't be used for default gems' exe files 2022-01-18 15:56:48 +09:00
man [ruby/irb] Add help about extra doc dir option 2021-10-11 21:12:58 +09:00
misc Treat TS_ICVARC cache as separate from TS_IVC cache 2022-02-02 09:20:34 -08:00
missing [wasm] wasm/missing.{c,h}: add missing libc stubs for wasi-libc 2022-01-19 11:19:06 +09:00
sample Remove obsolete Fixnum and Bignum 2021-12-28 18:35:03 +09:00
spec [rubygems/rubygems] Fix corrupted lockfile when using `gemspec` and multiple sources 2022-02-11 18:20:20 +09:00
template [Feature #18491] Drop support for HP-UX 2022-01-18 09:52:15 -05:00
test test/ruby/test_exception.rb: prevent "assigned but unused variable" 2022-02-12 00:36:01 +09:00
tool Treat TS_ICVARC cache as separate from TS_IVC cache 2022-02-02 09:20:34 -08:00
wasm * expand tabs. [ci skip] 2022-01-19 11:19:20 +09:00
win32 Fixed an missing percent in the batch file 2022-01-24 18:10:17 +09:00
.appveyor.yml Appveyor: Link vcpkg DLLs except for readline 2022-02-07 15:30:07 +09:00
.cirrus.yml Skip tests if only document files changed on Cirrus-CI [ci skip] 2021-11-25 11:10:34 +09:00
.dir-locals.el emacs mode addition 2020-02-06 11:46:51 +09:00
.document marshal.c Marshal.load accepts a freeze: true option. 2021-10-05 18:34:56 +02:00
.editorconfig
.gdbinit .gdbinit: Fix indentation in print_id [ci skip] 2021-02-06 13:03:40 -05:00
.gitattributes Add tool/leaked-globals to .gitattributes [ci skip] 2019-07-15 13:45:14 +09:00
.gitignore [wasm] add unit test suite for fiber, register scan, sjlj in platform dir 2022-01-19 11:19:06 +09:00
.rdoc_options [DOC] Add `.rdoc_options` file 2022-02-11 11:25:05 +09:00
.rspec_parallel Introduce test-bundler-parallel task. 2019-08-22 08:02:48 +10:00
.travis.yml Ignore hung-ups after success on s390x-linux tentatively [ci skip] 2021-12-21 13:40:28 +09:00
BSDL [ruby/irb] Reformat LICENSE.txt [ci skip] 2020-02-02 03:22:51 +09:00
CONTRIBUTING.md [DOC] Fix broken links [ci skip] 2021-09-15 14:16:14 +09:00
COPYING
COPYING.ja
GPL
KNOWNBUGS.rb Remove known use-after-poison bug 2020-10-03 00:45:06 +09:00
LEGAL LEGAL: mention error_highlight 2021-12-13 14:21:29 +09:00
NEWS.md Update default gems list at f07a2613e3 [ci skip] 2022-02-10 08:19:42 +00:00
README.EXT
README.EXT.ja
README.ja.md Update badges from README.md [ci skip] 2021-12-24 09:05:12 +09:00
README.md Remove the macOS badge [ci skip] 2021-12-11 23:05:16 +09:00
aclocal.m4 get rid of aclocal (#4280) 2021-03-17 18:52:53 +09:00
addr2line.c Cast to void pointer for `%p` in commented out code [ci skip] 2021-10-20 11:22:33 +09:00
addr2line.h add #include guard hack 2020-04-13 16:06:00 +09:00
array.c [DOC] Simplify operator method references 2022-02-12 12:38:36 +09:00
array.rb Use `Primitive.mandatory_only?` for `Array#sample` 2021-11-15 15:58:56 +09:00
ast.c Make RubyVM::AST.of work with code written in `-e` command-line option 2021-12-26 20:57:34 +09:00
ast.rb ast.c: Rename "save_script_lines" to "keep_script_lines" 2021-08-20 16:18:36 +09:00
autogen.sh autogen.sh: Copy auxiliary files instead of symlinks with `-i` 2021-12-06 17:53:37 +09:00
bignum.c [DOC] Integer#coerce deals with also Float 2021-12-29 11:50:28 +09:00
builtin.c Fix trivial -Wundef warnings 2021-05-04 14:56:55 +02:00
builtin.h `rb_vm_lvar_exposed()` is PUREFUNC 2021-11-15 13:11:30 +09:00
class.c Fix the placeholder subclass entry skipping [Bug #18489] 2022-01-17 21:23:40 +09:00
common.mk Try make this more readable and consistent with other targets 2022-02-01 08:09:23 +09:00
compar.c [DOC] Simplify operator method references 2022-02-12 12:38:36 +09:00
compile.c Fix indents [ci skip] 2022-02-03 11:21:41 +09:00
complex.c [DOC] Fix broken links to literals.rdoc 2022-02-08 01:27:52 +09:00
configure.ac Check if `execv` is available for ruby/missing.h 2022-01-26 18:23:51 +09:00
constant.h add #include guard hack 2020-04-13 16:06:00 +09:00
cont.c `rb_fiber_terminate` must not return [Bug #18497] 2022-01-19 19:57:16 +09:00
darray.h Add rb_darray_clear() for Kevin. Fix some warnings. 2021-10-20 18:19:40 -04:00
debug.c `USE_RUBY_DEBUG_LOG` doesn't check `RUBY_DEVEL` 2021-12-29 00:22:02 +09:00
debug_counter.c make RB_DEBUG_COUNTER_INC()_thread-safe 2020-12-17 03:43:59 +09:00
debug_counter.h optimize `Struct` getter/setter 2021-11-19 08:32:39 +09:00
dir.c dir.c: ignore ENOTCAPABLE while glob similar to EACCES 2022-01-19 11:19:06 +09:00
dir.rb Fix documentation for Dir.glob 2022-01-04 12:38:50 -08:00
dln.c Fix warnings 2022-01-20 10:03:59 +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 add #include guard hack 2020-04-13 16:06:00 +09:00
encoding.c suppress warnings for probable NULL dererefences 2021-10-24 19:24:50 +09:00
enum.c [DOC] Use RDoc link style for links in the same class/module 2022-02-07 09:52:06 -05:00
enumerator.c Introduce `RBIMPL_NONNULL_ARG` macro 2021-09-27 14:47:52 +09:00
error.c Don't segfault if Warning.warn is undefined 2022-01-04 10:03:18 -08:00
eval.c Remove Refinement#{extend_object,append_features,prepend_features} 2022-01-05 10:59:03 -08:00
eval_error.c Trim extra whitespace in inaccesible error message 2021-09-01 13:18:55 +09:00
eval_intern.h `rb_fiber_terminate` must not return [Bug #18497] 2022-01-19 19:57:16 +09:00
eval_jump.c Protoized old pre-ANSI K&R style declarations and definitions 2021-05-07 00:04:36 +09:00
file.c [DOC] Replace with IO@Modes 2022-02-07 09:52:06 -05:00
gc.c Free cached mark stack chunks when freeing objspace 2022-02-10 09:33:42 -05:00
gc.h Add the size pool slot size to the output of ObjectSpace.dump/dump_all 2022-02-03 15:07:35 -05:00
gc.rb [Feature #18364] Add GC.stat_heap to get stats for memory heaps 2022-01-04 09:46:36 -05:00
gem_prelude.rb Silence LoadError only if it is for `rubygems` itself 2021-08-18 21:37:31 +09:00
golf_prelude.rb
goruby.c goruby.c: include golf_prelude.c to get rid of overwriting EXTOBJS 2021-07-03 22:39:14 +09:00
hash.c [DOC] Simplify operator method references 2022-02-12 12:38:36 +09:00
hrtime.h
id_table.c Support ID_TABLE_STOP for replace function 2022-01-25 16:51:16 -05:00
id_table.h Rename rb_id_table_foreach_with_replace 2022-01-25 16:51:16 -05:00
inits.c IO::Buffer for scheduler interface. 2021-11-10 19:21:05 +13:00
insns.def Treat TS_ICVARC cache as separate from TS_IVC cache 2022-02-02 09:20:34 -08:00
internal.h Using RB_BIGNUM_TYPE_P macro 2021-09-11 09:13:24 +09:00
io.c [DOC] Simplify operator method references 2022-02-12 12:38:36 +09:00
io.rb [Feature #16254] Use `Primitive.func` style 2020-06-19 18:46:55 +09:00
io_buffer.c io_buffer.c: use mremap based resizing only when mremap available 2022-01-07 02:13:19 +09:00
iseq.c Fix indents [ci skip] 2022-02-03 11:21:41 +09:00
iseq.h add `rb_iseq_type()` to return iseq type in Symbol 2021-12-19 05:16:29 +09:00
kernel.rb Improve performance Kernel#Float with using Primitive.mandatory_only? method [Feature #18344] (#5133) 2021-11-17 20:26:40 -08:00
lex.c.blt
load.c Fix TAG_THROW through require [Bug #18562] 2022-02-05 18:10:19 -08:00
loadpath.c
localeinit.c win32: Use UTF-8 as filesystem encoding [Feature #12654] 2020-12-20 18:34:04 +09:00
main.c [wasm] add asyncify based setjmp, fiber, register scan emulation 2022-01-19 11:19:06 +09:00
marshal.c Fix typos [ci skip] 2021-12-25 10:33:49 +09:00
marshal.rb [DOC] Document Marshal#load parameter freeze: (#5332) 2021-12-24 09:55:09 +01:00
math.c Using RB_FLOAT_TYPE_P macro 2021-09-12 11:16:31 +09:00
memory_view.c memory_view.c: Add _memory_view_entry member in rb_memory_view_t (#5088) 2021-11-08 12:52:09 +09:00
method.h Fix memory leak at the same named alias [Bug #18516] 2022-01-27 15:46:08 +09:00
mini_builtin.c * expand tabs. [ci skip] 2021-06-17 06:09:26 +09:00
miniinit.c support builtin features with Ruby and C. 2019-11-08 09:09:29 +09:00
mjit.c Transfer the responsibility for MJIT options to mjit.c 2022-01-15 18:57:33 +09:00
mjit.h Cleanup diff against upstream. Add comments 2021-10-20 18:19:42 -04:00
mjit_compile.c Extract precompile_inlinable_child_iseq to separate alloca for each iseq 2021-10-12 17:12:01 +09:00
mjit_worker.c Rename --jit to --mjit (#5248) 2021-12-13 16:08:01 -08: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 Remove `NODE_DASGN_CURR` [Feature #18406] 2021-12-13 12:53:03 +09:00
node.h Remove `NODE_DASGN_CURR` [Feature #18406] 2021-12-13 12:53:03 +09:00
numeric.c [DOC] Simplify operator method references 2022-02-12 12:38:36 +09:00
numeric.rb Add examples for Integer.try_convert [ci skip] 2021-12-15 02:12:37 +09:00
object.c [DOC] Simplify operator method references 2022-02-12 12:38:36 +09:00
pack.c pack.c: add an offset argument to unpack and unpack1 2021-10-26 22:27:30 +02:00
pack.rb [DOC] Fix String#unpack and #unpack1 docs (#5331) 2021-12-23 21:58:13 +01:00
parse.y Reuse operation rule for operation2 2022-02-12 12:28:07 +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 internal/vm.h rework 2019-12-26 20:45:12 +09:00
proc.c [DOC] Fix broken links to literals.rdoc 2022-02-08 01:27:52 +09:00
process.c Accurately report VM memsize 2022-01-21 14:34:53 -08:00
ractor.c `USE_RUBY_DEBUG_LOG` doesn't check `RUBY_DEVEL` 2021-12-29 00:22:02 +09:00
ractor.rb [DOC] Fix broken links [ci skip] 2021-09-15 14:16:14 +09:00
ractor_core.h Move rb_ractor_p definition 2021-10-04 08:21:40 +09:00
random.c [DOC] Mark up the code for Kernel#rand as the same as Random#rand 2022-01-13 11:34:09 +09:00
range.c [DOC] Simplify operator method references 2022-02-12 12:38:36 +09:00
rational.c [DOC] Fix broken links to literals.rdoc 2022-02-08 01:27:52 +09:00
re.c [DOC] Fix broken links to literals.rdoc 2022-02-08 01:27:52 +09:00
regcomp.c Cast up to get rid of the potential overflow posibility 2021-10-14 18:43:32 +09:00
regenc.c
regenc.h
regerror.c Add printf-style format attribute to oniguruma functions 2021-09-27 19:02:45 +09:00
regexec.c Fixed shorten-64-to-32 errors when USE_COMBINATION_EXPLOSION_CHECK 2021-05-07 20:15:05 +09:00
regint.h Add printf-style format attribute to oniguruma functions 2021-09-27 19:02:45 +09:00
regparse.c Add printf-style format attribute to oniguruma functions 2021-09-27 19:02:45 +09:00
regparse.h
regsyntax.c
ruby-runner.c sed -i 's|ruby/impl|ruby/internal|' 2020-05-11 09:24:08 +09:00
ruby.c ruby.c: initialize extra optional extensions linked statically 2022-01-19 11:19:06 +09:00
ruby_assert.h internal/*.h: skip doxygen 2021-09-10 20:00: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 Add fiber scheduler hooks for `pread`/`pwrite`, and add support to `IO::Buffer`. 2021-12-23 12:20:09 +13:00
signal.c Use free instead of xfree to free altstack 2021-09-06 14:22:24 +09:00
siphash.c Fix compilation error in mingw 2021-05-04 20:38:03 -04:00
siphash.h
sparc.c
sprintf.c Use C99-defined macros to classify a floating-point number 2021-08-27 12:41:30 +09:00
st.c st.c: Do not clear entries_bound when calling Hash#shift for empty hash 2022-02-10 00:14:27 +09:00
strftime.c Using RB_BIGNUM_TYPE_P macro 2021-09-11 09:13:24 +09:00
string.c [DOC] Remove unnecessary `rdoc-ref:` schemes 2022-02-12 12:38:37 +09:00
struct.c [DOC] Simplify operator method references 2022-02-12 12:38:36 +09:00
symbol.c Assign temporary ID to anonymous ID [Bug #18250] 2021-11-23 21:03:19 +09:00
symbol.h include/ruby/backward/2/r_cast.h: deprecate 2020-08-27 15:03:36 +09:00
thread.c Accurately report VM memsize 2022-01-21 14:34:53 -08:00
thread_none.c [wasm] add no thread variant for freestanding environment 2022-01-19 11:19:06 +09:00
thread_none.h [wasm] add no thread variant for freestanding environment 2022-01-19 11:19:06 +09:00
thread_pthread.c thread.c: put platform specific part in each impl file 2022-01-19 11:19:06 +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 [DOC] Improve Thread::Queue.new docs [ci skip] 2021-12-15 11:25:33 +09:00
thread_win32.c thread.c: put platform specific part in each impl file 2022-01-19 11:19:06 +09:00
thread_win32.h Get rid of duplicate typedef 2021-09-03 22:47:58 +09:00
time.c Speed up and avoid kwarg hash alloc in Time.now 2022-01-12 12:55:14 -08:00
timev.h decouple internal.h headers 2019-12-26 20:45:12 +09:00
timev.rb [DOC] Simplify operator method references 2022-02-12 12:38:36 +09:00
trace_point.rb `TracePoint.allow_reentry` 2021-12-10 00:56:25 +09:00
transcode.c Add `econv_get_encoding` function 2022-02-02 22:52:55 +09:00
transcode_data.h add #include guard hack 2020-04-13 16:06:00 +09:00
transient_heap.c `USE_RUBY_DEBUG_LOG` doesn't check `RUBY_DEVEL` 2021-12-29 00:22:02 +09:00
transient_heap.h cancel theap on multi-ractors 2020-12-07 08:28:36 +09:00
util.c include/ruby/internal/ctype.h: add doxygen 2021-09-10 20:00:06 +09:00
variable.c variable.c: Fix incorrect identation in `const_added` 2022-01-14 16:22:57 +01:00
variable.h internal/*.h: skip doxygen 2021-09-10 20:00:06 +09:00
version.c Rename --jit to --mjit (#5248) 2021-12-13 16:08:01 -08:00
version.h * 2022-02-12 [ci skip] 2022-02-12 00:36:39 +09:00
vm.c Fix error: old-style function definition 2022-01-22 15:48:05 +09:00
vm_args.c Using NIL_P macro instead of `== Qnil` 2021-10-03 22:34:45 +09:00
vm_backtrace.c [DOC] Document Thread::Backtrace.limit 2021-12-20 08:56:03 -08:00
vm_callinfo.h Remove a typo hash [ci skip] 2022-01-29 15:33:13 +09:00
vm_core.h [wasm] eval_inter.h gc.c vm_core.h: include wasm/setjmp.h instead of sysroot header 2022-01-19 11:19:06 +09:00
vm_debug.h `USE_RUBY_DEBUG_LOG` doesn't check `RUBY_DEVEL` 2021-12-29 00:22:02 +09:00
vm_dump.c enable `RUBY_ON_BUG` on release build 2022-01-25 16:43:57 +09:00
vm_eval.c Lazily create singletons on instance_{exec,eval} (#5146) 2021-12-02 15:53:39 -08:00
vm_exec.c Cleanup diff against upstream. Add comments 2021-10-20 18:19:42 -04:00
vm_exec.h Remove the scraper 2021-10-20 18:19:38 -04:00
vm_insnhelper.c Streamline cached attr reader / writer indexes 2022-01-26 09:02:59 -08:00
vm_insnhelper.h Count interpreter instructions when -DYJIT_STATS=1 2021-10-20 18:19:40 -04:00
vm_method.c Fix memory leak at the same named alias [Bug #18516] 2022-01-27 15:46:08 +09:00
vm_opts.h oops Direct threading should be default 2021-10-20 18:19:25 -04:00
vm_sync.c Supress `warning: data argument not used by format string [-Wformat-extra-args]` 2021-10-20 07:48:30 +09:00
vm_sync.h `USE_RUBY_DEBUG_LOG` doesn't check `RUBY_DEVEL` 2021-12-29 00:22:02 +09:00
vm_trace.c Fix error: old-style function definition 2022-01-22 15:48:05 +09:00
vsnprintf.c [Feature #18491] Drop support for HP-UX 2022-01-18 09:52:15 -05:00
warning.rb Use category: :deprecated in warnings that are related to deprecation 2020-12-18 09:54:11 -08:00
yjit.c YJIT: Add support for ruby array cfuncs (argc=-2) 2022-01-08 11:40:55 -08:00
yjit.h re-enabled YJIT on x64-mswin64 2021-12-31 20:13:11 +09:00
yjit.rb Prefer RBOOL 2022-01-01 17:02:04 +09:00
yjit_asm.c Tiny mmap emulation for Windows 2021-12-27 15:56:23 +09:00
yjit_asm.h YJIT: Bounds check every byte in the assembler 2021-12-03 20:02:25 -05:00
yjit_codegen.c Suppress unary minus operator to unsigned type warnings 2022-01-14 13:46:12 +09:00
yjit_codegen.h YJIT: Fail gracefully while OOM for new entry points 2021-12-01 12:25:28 -05:00
yjit_core.c YJIT: Use proper size prefix and conversion where IL32LLP64 2021-12-29 14:09:37 +09:00
yjit_core.h YJIT: Remove unused branch_t::src_ctx field 2021-12-15 16:13:23 -05:00
yjit_iface.c YJIT: Avoid pointer size assumption with intptr_t 2021-12-30 08:21:51 -05:00
yjit_iface.h YJIT code pages refactoring for code GC (#5073) 2021-11-04 16:05:41 -04:00
yjit_utils.c YJIT: Add ability to exit to interpreter from stubs 2021-11-26 18:00:42 -05:00

README.md

Actions Status: MinGW Actions Status: MJIT Actions Status: Ubuntu Actions Status: Windows AppVeyor status Travis Status Cirrus 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/maintainers.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 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