development fork of ruby/ruby

Перейти к файлу

Burdette Lamar e3a988a29c [DOC] Revisions for call-seq in doc guidelines (#6121 ) Splits certain guidelines for singleton and instance method. Calls for instance method to not prefix anything (like RDoc itself for a Ruby-coded instance method); e.g.: count -> integer, not array.count,. <=> other -> integer or nil, not hash <=> other -> integer or nil. Groups previous guidelines into Arguments, Block, Return types, Aliases.		2022-07-12 20:49:24 -05:00
.github	Tentatively put macOS CIs back with adding macOS 12	2022-07-07 15:06:10 +09:00
basictest	…
benchmark	vm_opt_ltlt: call rb_str_buf_append directly if RHS is a String	2022-07-06 17:25:58 +02:00
bin	…
bootstraptest	Replace use of double_heap in tests with expand_heap	2022-07-11 09:00:03 -04:00
ccan	Prefix ccan headers (#4568 )	2022-03-30 20:36:31 +13:00
coroutine	Add support for address sanitizer for amd64 and arm64.	2022-05-25 15:24:24 +12:00
coverage	…
cygwin	Suppress msys2 pathname conversion also at single test runs [ci skip]	2022-07-06 00:22:32 +09:00
defs	Set `SDKROOT` to empty value [ci skip]	2022-07-06 00:32:26 +09:00
doc	[DOC] Revisions for call-seq in doc guidelines (#6121 )	2022-07-12 20:49:24 -05:00
enc	Remove Unicode 13.0.0 related files	2022-03-16 08:30:04 +09:00
ext	Move timestamps directory for bundled gems	2022-07-13 00:00:46 +09:00
gems	Update bundled gems list at 2022-07-12	2022-07-12 07:03:23 +00:00
include	Fix some UBSAN false positives (#6115 )	2022-07-12 11:48:10 -07:00
internal	[Feature #18901 ] Support size pool movement for Arrays	2022-07-12 08:50:33 -04:00
lib	[ruby/irb] [DOC] Include updated help message (https://github.com/ruby/irb/pull/377 )	2022-07-12 00:05:15 +09:00
libexec	Merge rubygems master 1e4eda741d732ca1bd7031aef0a16c7348adf7a5	2022-04-28 19:08:49 +09:00
man	[ci skip] Improve man page docs around --dump options	2022-06-28 10:10:26 -04:00
misc	fix lldb scripts on older lldb python	2022-07-06 13:21:37 -07:00
missing	Fix dtoa buffer overrun	2022-04-12 21:30:49 +09:00
sample	Fix typo in README (#5925 )	2022-05-20 14:45:46 -07:00
spec	[rubygems/rubygems] Fix `simulate_windows` helper	2022-07-08 02:22:35 +09:00
template	Add yjit.o to DTRACE_DEPENDENT_OBJS	2022-05-30 18:30:57 -04:00
test	[Feature #18901 ] Don't run size pool move tests without VWA	2022-07-12 08:50:33 -04:00
tool	Use `File::PATH_SEPARATOR` for the portability	2022-07-09 19:00:56 +09:00
wasm	[wasm] get rid of workaround use of older binaryen and update to latest	2022-07-06 11:59:38 +09:00
win32	[Win32] allow pipe in flock	2022-04-21 15:14:08 +09:00
yjit	Speed up --yjit-trace-exits code (#6106 )	2022-07-12 16:40:49 -04:00
.appveyor.yml	Skip CIs if the head commit message contains '[DOC]'	2022-06-19 11:05:31 +09:00
.cirrus.yml	[DOC] Fix ghcr link	2022-03-31 08:35:39 +09:00
.dir-locals.el	…
.document	Improve documentation on contributing to Ruby	2022-05-11 10:59:24 -04:00
.editorconfig	…
.gdbinit	…
.gitattributes	…
.gitignore	Ignore rubyspec_temp fot Git	2022-05-09 07:29:37 +09:00
.rdoc_options	[DOC] Set the documentation title and main page	2022-02-21 13:08:06 +09:00
.rspec_parallel	…
.travis.yml	Skip CIs if the head commit message contains '[DOC]'	2022-06-19 11:05:31 +09:00
BSDL	…
CONTRIBUTING.md	Improve documentation on contributing to Ruby	2022-05-11 10:59:24 -04:00
COPYING	…
COPYING.ja	…
GPL	…
KNOWNBUGS.rb	…
LEGAL	…
NEWS.md	Update bundled gems list at 2022-07-12	2022-07-12 07:03:23 +00:00
README.EXT	…
README.EXT.ja	…
README.ja.md	…
README.md	Update "Reporting Issues" link in the README	2022-06-08 17:49:56 +09:00
aclocal.m4	…
addr2line.c	Fix warnings by old gcc	2022-06-23 22:52:45 +09:00
addr2line.h	…
array.c	[Feature #18901 ] Support size pool movement for Arrays	2022-07-12 08:50:33 -04:00
array.rb	…
ast.c	Add ISEQ_BODY macro	2022-03-24 10:03:51 -04:00
ast.rb	…
autogen.sh	…
bignum.c	Fix the condition when a new buffer is needed without GMP	2022-06-02 10:29:53 +09:00
builtin.c	…
builtin.h	Typedef built-in function types	2022-06-02 16:05:35 +09:00
class.c	Add Module#undefined_instance_methods	2022-06-06 09:57:32 -07:00
common.mk	Fix some UBSAN false positives (#6115 )	2022-07-12 11:48:10 -07:00
compar.c	Using RBOOL in cmp_between func	2022-06-17 11:59:49 +09:00
compile.c	Check only whether `RUBY_DEVEL` is defined	2022-07-12 17:13:57 +09:00
complex.c	[DOC] Fix broken links to literals.rdoc	2022-02-08 01:27:52 +09:00
configure.ac	Fix invalid mkdir detection on OpenBSD	2022-07-08 21:08:19 -07:00
constant.h	…
cont.c	cont.c: prevent a warning of GCC 12.1	2022-06-13 15:18:28 +09:00
darray.h	Remove _with_gc functions in darray	2022-05-03 09:07:39 -04:00
debug.c	small fix on `setup_debug_log()`	2022-06-10 23:56:49 +09:00
debug_counter.c	Fix leaked global symbols for debug counter	2022-07-03 00:05:53 +09:00
debug_counter.h	…
dir.c	Allow to just warn as bool expected, without an exception	2022-06-20 19:35:12 +09:00
dir.rb	fix typo in dir documentation (#6002 )	2022-06-10 22:22:16 -07:00
dln.c	[Bug #18879 ] Fix macOS version detections	2022-06-27 01:08:46 +09:00
dln.h	…
dln_find.c	…
dmydln.c	…
dmyenc.c	…
dmyext.c	…
encindex.h	…
encoding.c	[DOC] Main doc for encodings moved from encoding.c to doc/encodings.rdoc (#5748 )	2022-04-01 20:41:04 -05:00
enum.c	Revert flawed doc for slice_after, slice_when, and chunk_while (#5952 )	2022-05-28 14:20:00 -05:00
enumerator.c	…
error.c	Include JIT information in crash reports	2022-06-20 17:18:29 -04:00
eval.c	Remove unnecessary module flag, add module assertions to other module flags	2022-05-23 11:04:34 -07:00
eval_error.c	Remove unneeded newline from detailed_message	2022-02-22 11:55:40 +09:00
eval_intern.h	…
eval_jump.c	…
file.c	Remove no longer used label [ci skip]	2022-06-29 12:38:12 +09:00
gc.c	[Feature #18901 ] Support size pool movement for Arrays	2022-07-12 08:50:33 -04:00
gc.h	Use `size_t` for `rb_raw_obj_info`	2022-07-10 13:03:22 +09:00
gc.rb	Add expand_heap option to GC.verify_compaction_references	2022-07-11 09:00:03 -04:00
gem_prelude.rb	…
golf_prelude.rb	…
goruby.c	…
hash.c	ENV.merge! support multile arguments [Feature #18279 ]	2022-06-17 01:22:24 +09:00
hrtime.h	thread.c: Move double2hrtime and hrtime2double to hrtime.h	2022-03-30 16:50:46 +09:00
id_table.c	…
id_table.h	…
inits.c	Move RubyVM::MJIT to builtin Ruby	2022-06-15 10:52:37 -07:00
insns.def	RubyVM.stat constant cache metrics (#5766 )	2022-04-05 16:37:00 -04:00
internal.h	Fix macro redefinition warning for MacOS	2022-07-08 01:07:19 +09:00
io.c	[Bug #18892 ] Reset `ARGF.lineno` after reading shebang	2022-07-07 11:33:07 +09:00
io.rb	…
io_buffer.c	Fix a variable name typo in the docs	2022-06-25 11:29:08 +12:00
iseq.c	Simplify BLSR code	2022-07-08 15:59:25 +09:00
iseq.h	Use `roomof` macro	2022-07-08 12:11:56 +09:00
kernel.rb	…
lex.c.blt	…
load.c	Clarify documentation of Kernel#require_relative	2022-06-21 18:40:28 +02:00
loadpath.c	…
localeinit.c	…
main.c	Check only whether `RUBY_DEVEL` is defined	2022-07-12 17:13:57 +09:00
marshal.c	Using is_ascii_string to check encoding	2022-06-17 12:02:50 +09:00
marshal.rb	…
math.c	[DOC] Enhanced RDoc for Math module (#5837 )	2022-04-25 10:07:21 -05:00
memory_view.c	Only check class ancestors for ivar in memory_view	2022-05-27 13:38:40 -07:00
method.h	Allow method caching of protected FCALLs	2022-06-21 18:33:51 -07:00
mini_builtin.c	…
miniinit.c	…
mjit.c	MJIT: s/assert/VM_ASSERT/	2022-07-11 23:49:13 -07:00
mjit.h	Remove MJIT worker thread (#6006 )	2022-06-15 09:40:54 -07:00
mjit.rb	Move RubyVM::MJIT to builtin Ruby	2022-06-15 10:52:37 -07:00
mjit_compile.c	Speed up ISeq by marking via bitmaps and IC rearranging	2022-06-23 14:01:46 -07:00
mjit_worker.c	MJIT: Add assertions for mjit_capture_cc_entries	2022-07-12 00:07:38 -07:00
nilclass.rb	…
node.c	…
node.h	…
numeric.c	[DOC] Fix documentation of Numeric#div: Complex does not have #div	2022-06-03 14:35:47 +09:00
numeric.rb	…
object.c	Allow to just warn as bool expected, without an exception	2022-06-20 19:35:12 +09:00
pack.c	…
pack.rb	[DOC] Repair format and links in What's Here sections (#5711 )	2022-03-25 10:52:06 -05:00
parse.y	Fix some UBSAN false positives (#6115 )	2022-07-12 11:48:10 -07:00
prelude.rb	Make Set a builtin feature [Feature #16989 ]	2022-02-18 11:56:24 +09:00
probes.d	…
probes_helper.h	…
proc.c	Reuse `rb_proc_arity`	2022-04-24 14:06:45 -07:00
process.c	[DOC] Document `Process::Tms`	2022-06-28 20:19:05 +09:00
ractor.c	rename thread internal naming	2022-04-22 07:54:09 +09:00
ractor.rb	…
ractor_core.h	cleanup by `RUBY_DEBUG_LOG2` and `VM_ASSERT`	2022-05-24 02:22:41 +09:00
random.c	…
range.c	Fix Range#cover? returning true for beginless ranges of different types	2022-06-06 09:59:22 -07:00
rational.c	Disable GMP by -DUSE_GMP=0	2022-05-20 19:05:35 +09:00
re.c	[DOC] Fix a typo [ci skip]	2022-06-26 14:17:14 +09:00
regcomp.c	Just free compiled pattern if no space is used	2022-04-12 20:24:14 +09:00
regenc.c	…
regenc.h	Move ruby.h in `#ifdef RUBY` block	2022-03-11 15:08:23 +09:00
regerror.c	…
regexec.c	re.c: Add Regexp.timeout= and Regexp.timeout	2022-03-30 16:50:46 +09:00
regint.h	re.c: Add Regexp.timeout= and Regexp.timeout	2022-03-30 16:50:46 +09:00
regparse.c	Fix some UBSAN false positives (#6115 )	2022-07-12 11:48:10 -07:00
regparse.h	…
regsyntax.c	…
ruby-runner.c	…
ruby.c	See the environment variable and then check if JIT options conflict	2022-07-08 19:10:18 +09:00
ruby_assert.h	…
ruby_atomic.h	…
rubystub.c	…
scheduler.c	…
signal.c	…
siphash.c	…
siphash.h	…
sparc.c	[DOC]Some link prefix replace	2022-04-09 17:43:46 +09:00
sprintf.c	…
st.c	st.c: Fix a typo in a comment	2022-02-28 11:40:25 +09:00
strftime.c	…
string.c	Using is_ascii_string to check encoding	2022-06-17 12:02:50 +09:00
string.rb	[DOC] Fix markup for `String` (#5984 )	2022-06-09 13:40:21 -05:00
struct.c	Don't attempt to read ivars on T_ICLASS in struct (#5664 )	2022-05-26 11:54:15 -07:00
symbol.c	[DOC] Move the documentations of moved Symbol methods	2022-04-14 11:17:37 +09:00
symbol.h	…
thread.c	Use VM Lock when mutating waiting threads list	2022-07-12 16:07:41 -07:00
thread_none.c	GVL Instrumentation API: add STARTED and EXITED events	2022-06-17 09:08:26 +02:00
thread_none.h	introduce struct `rb_native_thread`	2022-04-23 03:08:27 +09:00
thread_pthread.c	thread_pthread.c: call SUSPENDED event when entering native_sleep	2022-07-07 17:49:00 +02:00
thread_pthread.h	altstack is native thread's attr	2022-05-24 17:50:49 +09:00
thread_sync.c	Prefix ccan headers (#4568 )	2022-03-30 20:36:31 +13:00
thread_win32.c	Fix warnings by old gcc	2022-06-23 22:52:45 +09:00
thread_win32.h	`native_tls_get()`' should not check results	2022-05-24 10:06:51 +09:00
time.c	[DOC] Enhanced RDoc for Time (#6118 )	2022-07-12 13:21:32 -05:00
timev.h	…
timev.rb	[DOC] prefer rdoc references over generated URLs	2022-02-19 15:14:01 +09:00
trace_point.rb	Fix comment	2022-03-29 18:14:33 -07:00
transcode.c	Using is_ascii_string to check encoding	2022-06-17 12:02:50 +09:00
transcode_data.h	…
transient_heap.c	…
transient_heap.h	…
util.c	…
variable.c	Get rid of a nasal demon	2022-06-23 16:42:57 +09:00
variable.h	…
version.c	Include JIT information in crash reports	2022-06-20 17:18:29 -04:00
version.h	* 2022-07-13 [ci skip]	2022-07-13 00:01:11 +09:00
vm.c	Fix infinite loop when b_return TracePoint throws	2022-06-22 08:30:39 -04:00
vm_args.c	Unflag a splatted flagged hash if the method doesn't use ruby2_keywords	2022-04-05 11:42:02 +02:00
vm_backtrace.c	Write Thread instead of Threade	2022-05-12 07:53:17 +09:00
vm_callinfo.h	…
vm_core.h	Flatten bitmap when there is only one element	2022-06-23 16:52:00 -07:00
vm_debug.h	Fix compile error	2022-06-09 09:35:08 +09:00
vm_dump.c	Prevent printing crash report in a loop	2022-06-03 13:50:32 -04:00
vm_eval.c	Add ISEQ_BODY macro	2022-03-24 10:03:51 -04:00
vm_exec.c	…
vm_exec.h	Add ISEQ_BODY macro	2022-03-24 10:03:51 -04:00
vm_insnhelper.c	vm_opt_ltlt: call rb_str_buf_append directly if RHS is a String	2022-07-06 17:25:58 +02:00
vm_insnhelper.h	Allow method caching of protected FCALLs	2022-06-21 18:33:51 -07:00
vm_method.c	Fix nested bmethod TracePoint and memory leak	2022-06-10 10:10:27 +09:00
vm_opts.h	…
vm_sync.c	Prefix ccan headers (#4568 )	2022-03-30 20:36:31 +13:00
vm_sync.h	…
vm_trace.c	Fix infinite loop when b_return TracePoint throws	2022-06-22 08:30:39 -04:00
vsnprintf.c	…
warning.rb	…
yjit.c	Speed up --yjit-trace-exits code (#6106 )	2022-07-12 16:40:49 -04:00
yjit.h	YJIT: Undef YJIT_SUPPORTED_P for hygiene	2022-06-26 08:36:10 -04:00
yjit.rb	Speed up --yjit-trace-exits code (#6106 )	2022-07-12 16:40:49 -04:00

README.md

What is 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 with Git

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

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

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.

Ruby home page

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

Documentation

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.

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 "Reporting Issues" for more information.

Contributing

See "Contributing to Ruby", which includes setup and build instructions.

The Author

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

matz@ruby-lang.org