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
Nobuyoshi Nakada afa9d65d61
make-snapshot: add -extlibs option
`make-snapshot` with `-extlibs` (or `-extlibs=yes`) includes
extracted and patched external library sources that the extension
libraries depend on.
2021-01-04 19:55:35 +09:00
.github Daily bundled_gems update [ci skip] 2021-01-04 16:42:44 +09:00
basictest Raise RuntimeError for class variable overtaken in nonverbose mode 2020-06-18 08:21:29 -07:00
benchmark Improve performance some Float methods [Feature #17498] (#4018) 2021-01-01 18:39:07 -08:00
bin Promote erb to default gems 2020-08-21 20:18:44 +09:00
bootstraptest add Ractor.main 2020-12-22 05:54:14 +09:00
ccan
coroutine Fix "Ruby is not properly fortified on armv7hl". 2020-12-08 23:37:42 +13:00
coverage
cygwin Merged recipes for the same target 2020-05-27 13:13:12 +09:00
defs gmake.mk: renamed BUNDLED_GEMS as bundled-gems 2020-12-02 17:04:33 +09:00
doc NEWS-3.0.0: backquote a few code related words. [doc] 2021-01-02 21:55:03 -05:00
enc transcode-tblgen.rb: make silent a little when just -v 2020-12-29 17:45:19 +09:00
ext Update ext/bigdecimal/depend 2021-01-04 13:42:10 +09:00
gems Updated bundled_gems 2021-01-04 19:55:34 +09:00
include Fixed dangling imemo_tmpbuf 2021-01-02 12:11:52 +09:00
internal Optimize calls to Kernel#hash (#3987) 2020-12-25 02:08:12 +09:00
lib Track Bundler master(2.3.0.dev) branch at 55634a8af18a52df86c4275d70fa1179118bcc20 2021-01-04 13:14:43 +09:00
libexec Removed unused option on racc 2020-09-28 18:53:25 +09:00
man Track Bundler master(2.3.0.dev) branch at 55634a8af18a52df86c4275d70fa1179118bcc20 2021-01-04 13:14:43 +09:00
misc Promote webrick to bundled gems 2020-12-10 18:06:25 +09:00
missing Removed obsolete autoconf checks 2020-12-12 17:23:44 +09:00
sample sample/trick2015/kinaba/entry.rb: The constant "Data" has been removed 2020-12-24 01:51:46 +09:00
spec Track Bundler master(2.3.0.dev) branch at 55634a8af18a52df86c4275d70fa1179118bcc20 2021-01-04 13:14:43 +09:00
template Fixed wrong configure option 2020-12-29 17:50:14 +09:00
test Track RubyGems master(3.3.0.dev) branch at 55634a8af18a52df86c4275d70fa1179118bcc20 2021-01-04 13:14:43 +09:00
tool make-snapshot: add -extlibs option 2021-01-04 19:55:35 +09:00
win32 ifchange: check the number of arguments 2021-01-04 15:54:09 +09:00
.dir-locals.el
.document Improve performance some Float methods [Feature #17498] (#4018) 2021-01-01 18:39:07 -08:00
.editorconfig
.gdbinit Add T_MOVED to rp command of GDB 2020-12-04 08:43:32 -08:00
.gitattributes
.gitignore Ignore static-ruby [ci skip] 2020-11-24 08:38:06 +09:00
.rspec_parallel
.travis.yml .travis.yml: delete x86_64 2020-11-04 12:11:13 +09:00
aclocal.m4
addr2line.c addr2line.c: support debuglink by build_id 2020-12-11 14:08:33 +09:00
addr2line.h
appveyor.yml Keep patched zlib files 2020-11-26 09:37:38 +09:00
array.c Document usage of ArithmeticSequence in Array#slice, and add to NEWS (#3952) 2020-12-21 09:32:30 +09:00
array.rb array.rb: Remove unnecessary phrase from rdoc 2020-11-12 16:59:59 +09:00
ast.c Unfreeze string-literal-only interpolated string-literal 2020-09-30 22:15:28 +09:00
ast.rb Fix RubyVM::AbstractSyntaxTree document 2020-06-24 15:17:53 +09:00
bignum.c Fixed indefinite articles before "Integer" [ci skip] 2020-12-21 01:19:55 +09:00
BSDL
builtin.c builtin_lookup: do not goto into a branch 2020-06-29 11:05:41 +09:00
builtin.h skip inlining cexpr! that are not attr! inline 2020-07-16 11:49:09 +09:00
class.c reset cache before iterating 2020-12-22 06:09:30 +09:00
common.mk Add a missing dependency 2021-01-03 22:48:13 -08:00
compar.c Don't redefine #rb_intern over and over again 2020-10-21 12:45:18 +09:00
compile.c Hoisted out compile_builtin_arg to refine messages 2021-01-01 23:32:07 +09:00
complex.c Removed canonicalization for mathn 2020-11-10 11:14:15 +09:00
configure.ac Disable DTrace in FreeBSD (#3999) 2020-12-25 12:06:46 +09:00
constant.h
cont.c Adjusted styles [ci skip] 2020-12-28 19:52:14 +09:00
CONTRIBUTING.md
COPYING
COPYING.ja
debug.c USE_RUBY_DEBUG_LOG is not defined !devel build 2020-12-25 09:52:18 +09:00
debug_counter.c make RB_DEBUG_COUNTER_INC()_thread-safe 2020-12-17 03:43:59 +09:00
debug_counter.h add debug counters for gc start events 2020-12-17 17:03:05 +09:00
dir.c dir.c: chdir conflict should raise only when called in different thread 2020-12-24 14:34:40 +09:00
dir.rb [DOC] more precise description of "**" in Dir.glob pattern [ci skip] 2020-10-27 08:55:10 +09:00
dln.c
dln.h dln.h: delete unused codes 2020-07-23 14:30:12 +09:00
dln_find.c dln_find_1: do not goto into a branch 2020-06-29 11:05:41 +09:00
dmydln.c
dmyenc.c
dmyext.c
encindex.h
encoding.c No sync on ASCII/US_ASCCII/UTF-8 2020-12-17 03:44:23 +09:00
enum.c Add Enumerable#compact and Enumerator::Lazy#compact 2021-01-02 17:27:24 +09:00
enumerator.c Add Enumerable#compact and Enumerator::Lazy#compact 2021-01-02 17:27:24 +09:00
error.c Bypass check for warning_category on internal calls 2020-12-28 12:44:03 +09:00
eval.c Remove obsoleted internal/mjit.h inclusion 2020-11-22 20:28:34 -08:00
eval_error.c Limit bactrace length from Exception#full_message 2020-12-27 20:50:15 +09:00
eval_intern.h Threads in a ractor will be killed with the ractor 2020-11-11 15:49:02 +09:00
eval_jump.c
file.c Revert "Removed deprecated Dir.exists? and File.exists?" 2020-12-02 19:11:01 +09:00
gc.c Stop managing valid class serials 2020-12-29 23:01:11 -08: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 Make any hash values fixable [Bug #17488] 2020-12-31 12:11:45 +09:00
hrtime.h
id_table.c Suppress unused-variable warning 2020-08-10 17:49:08 +09:00
id_table.h
inits.c Improve performance some Float methods [Feature #17498] (#4018) 2021-01-01 18:39:07 -08:00
insns.def Fix a cyclic explanation 2020-12-25 19:17:16 -08:00
internal.h RHASH_EMPTY_P: convert into an inline function 2020-08-19 15:10:53 +09:00
io.c Made an internal callback function static 2020-12-20 14:29:31 +09:00
io.rb [Feature #16254] Use Primitive.func style 2020-06-19 18:46:55 +09:00
iseq.c Make RubyVM::InstructionSequence.compile_file use same encoding as load 2020-11-19 07:12:50 +09:00
iseq.h check isolated Proc more strictly 2020-10-29 23:42:55 +09:00
kernel.rb Make Kernel#then, #yield_self, #frozen? builtin (#3283) 2020-07-03 18:02:43 -07:00
KNOWNBUGS.rb Remove known use-after-poison bug 2020-10-03 00:45:06 +09:00
LEGAL Added did_you_mean entry because did_you_mean uses MIT license 2020-08-19 19:36:16 +09:00
lex.c.blt
load.c Suppress a "clobbered" warning by gcc on macOS 2020-12-11 01:17:15 +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
marshal.c Don't redefine #rb_intern over and over again 2020-10-21 12:45:18 +09:00
math.c
memory_view.c [memory_view] Acquire VM lock while running exported_object_registry_free 2020-12-23 09:24:55 +09:00
method.h prohibi method call by defined_method in other racotrs 2020-09-25 20:37:38 +09:00
mini_builtin.c
miniinit.c
mjit.c Skip mjit_wait if iseq is not a target 2021-01-04 00:24:02 -08:00
mjit.h Skip mjit_wait if iseq is not a target 2021-01-04 00:24:02 -08:00
mjit_compile.c Prefer stdbool in vm_exec 2020-12-21 21:16:39 -08:00
mjit_worker.c Avoid hanging on --jit-wait after MJIT.pause 2021-01-03 00:05:38 -08:00
NEWS.md NEWS: We have links now, and there is no changelog anymore [doc] 2021-01-02 21:54:00 -05:00
node.c Change NODE layout for pattern matching 2020-11-01 16:19:07 +09:00
node.h Change NODE layout for pattern matching 2020-11-01 16:19:07 +09:00
numeric.c Improve performance some Float methods [Feature #17498] (#4018) 2021-01-01 18:39:07 -08:00
numeric.rb Improve performance some Float methods [Feature #17498] (#4018) 2021-01-01 18:39:07 -08:00
object.c [DOC] Fix typos 2020-12-24 23:09:51 +01:00
pack.c RARRAY_AREF: convert into an inline function 2020-08-15 12:09:26 +09:00
pack.rb [DOC] Fixed a typo [ci skip] 2020-11-16 22:14:59 +09:00
parse.y Fixed error message when % at EOF 2021-01-04 12:11:37 +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 [DOC] Update Proc.new without a block [ci skip] 2021-01-04 15:54:09 +09:00
process.c Updated access to Process::Status attributes 2020-12-24 23:35:18 +09:00
ractor.c introduce rb_ractor_atfork() 2020-12-24 04:30:50 +09:00
ractor.rb Add call-seq to Ractor doc; improve wording [doc] 2020-12-24 02:19:37 -05:00
ractor_core.h shareable_constant_value: experimental_copy 2020-12-24 14:28:47 +09:00
random.c Random instance methods 2020-12-21 19:22:38 -05:00
range.c Use public allocators for creating new T_OBJECT objects 2020-10-28 18:35:22 -07:00
rational.c Fix ArithmeticSequence#last and ArithmeticSequence#each for non-integer sequences (#3870) 2020-12-09 18:48:59 +09:00
re.c Use category: :deprecated in warnings that are related to deprecation 2020-12-18 09:54:11 -08:00
README.EXT
README.EXT.ja
README.ja.md Update labels of badges [ci skip] 2020-12-26 18:31:50 +09:00
README.md Update labels of badges [ci skip] 2020-12-26 18:31:50 +09:00
regcomp.c Right size literal regular expression buffers on compile 2020-12-10 18:15:26 +09:00
regenc.c
regenc.h
regerror.c
regexec.c
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 Ignore failure on unsupported fcntl to drop non-blocking mode 2020-12-26 09:45:06 +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 Add support for non-blocking Process.wait. 2020-12-09 08:55:35 +13:00
signal.c Signal handler type should be void 2020-12-12 17:02:42 +09:00
siphash.c Enable arm64 optimizations that exist for power/x86 (#3393) 2020-08-14 02:15:54 +09:00
siphash.h
sparc.c
sprintf.c sprintf.c: Removed conflicting definition 2020-09-28 12:51:53 +09:00
st.c [DOC] Fixed st_udpate comment [ci skip] 2020-11-30 12:18:21 +09:00
strftime.c rb_strftime_with_timespec: do not goto into a branch 2020-06-29 11:05:41 +09:00
string.c Minor grammar fix in String#chomp documentation 2020-12-30 01:25:00 -05:00
struct.c RHASH_TBL: is now ext-only 2020-08-19 15:10:53 +09:00
symbol.c sync ruby_global_symbols 2020-09-18 14:17:49 +09:00
symbol.h include/ruby/backward/2/r_cast.h: deprecate 2020-08-27 15:03:36 +09:00
thread.c introduce rb_ractor_atfork() 2020-12-24 04:30:50 +09:00
thread_pthread.c introduce USE_VM_CLOCK for windows. 2020-11-11 15:49:02 +09:00
thread_pthread.h fix public interface 2020-11-18 03:52:41 +09:00
thread_sync.c Proposed method for dealing with stack locals which have non-local lifetime. 2020-12-05 11:38:56 +13:00
thread_win32.c fix public interface 2020-11-18 03:52:41 +09:00
thread_win32.h fix public interface 2020-11-18 03:52:41 +09:00
time.c get_tmopt is no longer used 2020-12-31 17:25:07 +09:00
timev.h
timev.rb Moved Time.at to builtin 2020-12-31 17:25:07 +09:00
trace_point.rb [Feature #16513] TracePoint#inspect returns "... file:line" (#3391) 2020-08-06 11:56:24 +09:00
transcode.c Data: delete 2020-12-22 02:51:49 +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
variable.c Introduce Ractor::IsolationError 2020-12-21 22:29:05 +09:00
variable.h fix ivar with shareable objects issue 2020-12-12 06:19:18 +09:00
version.c
version.h * 2021-01-04 [ci skip] 2021-01-04 12:05:37 +09:00
vm.c Stop managing valid class serials 2020-12-29 23:01:11 -08:00
vm_args.c Run method_missing in the same execution context 2020-07-06 10:47:11 +09:00
vm_backtrace.c Ignore <internal: entries from core library methods for Kernel#warn(message, uplevel: n) 2020-10-26 08:47:33 +01:00
vm_callinfo.h fix inline method cache sync bug 2020-12-15 13:29:30 +09:00
vm_core.h separate rb_ractor_pub from rb_ractor_t 2020-12-22 00:03:00 +09:00
vm_debug.h support multiple filters by RUBY_DEBUG_LOG_FILTER 2020-08-02 04:24:47 +09:00
vm_dump.c vm debug: dump registers on ARM too. (#3900) 2020-12-16 15:32:11 +09:00
vm_eval.c Optimize calls to Kernel#hash (#3987) 2020-12-25 02:08:12 +09:00
vm_exec.c Enable arm64 optimizations that exist for power/x86 (#3393) 2020-08-14 02:15:54 +09:00
vm_exec.h RUBY_CONST_ASSERT: use STATIC_ASSERT instead 2020-07-10 12:23:41 +09:00
vm_insnhelper.c Fixed leaked global symbols 2020-12-26 09:39:53 +09:00
vm_insnhelper.h Fixed leaked global symbols 2020-12-26 09:39:53 +09:00
vm_method.c [DOC] Fix typos in vm_method.c 2020-12-26 22:50:55 +01:00
vm_opts.h Remove obsoleted opt_call_c_function insn (#3232) 2020-06-17 09:16:01 -07:00
vm_sync.c Fixed leaked global symbols 2020-12-26 09:39:53 +09:00
vm_sync.h Fixed leaked global symbols 2020-12-26 09:39:53 +09:00
vm_trace.c separate rb_ractor_pub from rb_ractor_t 2020-12-22 00:03:00 +09:00
vsnprintf.c
warning.rb Use category: :deprecated in warnings that are related to deprecation 2020-12-18 09:54:11 -08:00

Build Status Build status Actions Status: macOS Actions Status: MinGW Actions Status: MJIT Actions Status: Ubuntu Actions Status: Windows

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 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.

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. If ./configure does not exist or is older than configure.ac, run autoconf to (re)generate configure.

  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. Remove comment mark(#) before the module names from ext/Setup (or add module names if not present), if you want to link modules statically.

    If you don't want to compile non static extension modules (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