development fork of ruby/ruby
Перейти к файлу
Hiroshi SHIBATA a3493521a5 abort sync commit history when it failed to modify commit message. 2019-07-14 21:53:19 +09:00
basictest colors file has been moved from test to tool 2019-07-02 09:19:38 +09:00
benchmark * remove trailing spaces. 2019-07-12 17:57:28 +09:00
bin Added binstub for racc executables. 2019-06-19 18:18:17 +09:00
bootstraptest Improved fiber benchmarks. Increase number of iterations. 2019-07-12 11:56:51 +12:00
ccan ccan/list: sync with upstream 2018-02-01 08:59:27 +00:00
coroutine Add coroutine context switch for i386-mingw32 2019-07-07 21:33:47 +12:00
coverage Fix typo 2019-05-21 14:23:42 +09:00
cygwin
defs Do not make Unicode tables timestamp phony 2019-07-09 13:15:51 +09:00
doc [DOC] Fix typos [ci skip] 2019-07-14 16:00:34 +09:00
enc Include ruby/assert.h in ruby/ruby.h so that assertions can be there 2019-07-14 17:58:03 +09:00
ext socket: use frozen string buffer when releasing GVL 2019-07-14 20:46:51 +09:00
gems Update test-unit 2019-05-19 16:47:53 +09:00
include Introduce RUBY_DEBUG flag macro 2019-07-14 17:58:06 +09:00
lib Fix links to headings 2019-07-14 17:46:16 +09:00
libexec Backport racc-1.4.15 from upstream. 2019-06-19 18:17:25 +09:00
man Merge bundler master from upstream. 2019-06-09 12:44:10 +09:00
misc add FROZEN to lldb debug output 2019-05-09 12:27:44 -07:00
missing Split procstat_vm.c 2019-02-07 08:53:13 +00:00
sample For this may be a syntax error (instead of LocalJumpError) in Ruby 2.7 2019-02-04 06:28:57 +00:00
spec File::Stat uses Time#inspect 2019-07-11 19:46:11 +09:00
template Added depend files 2019-07-14 01:31:29 +09:00
test Check the result of String#-@ 2019-07-14 20:56:38 +09:00
tool abort sync commit history when it failed to modify commit message. 2019-07-14 21:53:19 +09:00
win32 Remove IA64 support. 2019-06-19 23:30:04 +12:00
.dir-locals.el add .dir-locals.el [ci skip] 2018-12-27 06:11:09 +00:00
.document Include LEGAL in .document [ci skip] 2018-12-01 12:05:37 +00:00
.editorconfig Remove duplicated and change order 2019-03-21 03:24:59 +00:00
.gdbinit Prefix global_symbols with `ruby_` 2019-05-16 15:43:16 +09:00
.gitattributes Add tool/format-release to .gitattributes 2019-04-23 14:09:45 +09:00
.gitignore Only ignore build directories. 2019-06-20 23:12:48 +12:00
.indent.pro
.travis.yml Add empty depend file if extconf.rb only exists 2019-07-14 03:04:23 +09:00
BSDL
CONTRIBUTING.md
COPYING COPYING: reformat as RDoc 2019-02-02 06:38:10 +00:00
COPYING.ja COPYING: reformat as RDoc 2019-02-02 06:38:10 +00:00
GPL
KNOWNBUGS.rb compile.c: fix positions encode 2018-04-05 13:13:00 +00:00
LEGAL Split procstat_vm.c 2019-02-07 08:53:13 +00:00
Makefile.in Dummy Makefile.in for CIs 2019-06-07 10:05:42 +09:00
NEWS NEWS: RubyVM.resolve_feature_path moved [ci skip] 2019-07-14 20:33:41 +09:00
README.EXT
README.EXT.ja
README.ja.md Prefer master rather than trunk in README [ci skip] 2019-07-01 01:05:29 +09:00
README.md Prefer master rather than trunk in README [ci skip] 2019-07-01 01:05:29 +09:00
aclocal.m4 configure.ac: check finite,isinf,isnan as macros first 2019-02-08 07:22:55 +00:00
addr2line.c addr2line.c (binary_filename): extend the buffer for NUL terminator 2019-07-14 20:23:29 +09:00
addr2line.h Support Mach-O on backtrace with DWARF 2018-10-20 06:35:25 +00:00
appveyor.yml Build AppVeyor only on master 2019-07-01 00:24:14 +09:00
array.c Implement Array#minmax 2019-07-02 08:07:06 -07:00
ast.c ast.c: update inspect results in the documents 2019-05-22 16:33:03 +09:00
azure-pipelines.yml Increase fetchDepth to prevent checkout failure 2019-07-14 20:17:05 +09:00
bignum.c [DOC] fix markups [ci skip] 2019-03-22 11:04:59 +00:00
class.c Eagerly name modules and classes 2019-05-22 15:46:47 +09:00
common.mk Include ruby/assert.h in ruby/ruby.h so that assertions can be there 2019-07-14 17:58:03 +09:00
compar.c Clarify requirements of <=> 2019-04-22 17:15:49 +09:00
compile.c * expand tabs. 2019-07-14 16:18:48 +09:00
complex.c Expand f_arg to use particular functions directly 2019-07-14 20:42:10 +09:00
configure.ac Add coroutine context switch for i386-mingw32 2019-07-07 21:33:47 +12:00
constant.h Module#constant_source_location [Feature #10771] 2019-06-23 01:46:38 +09:00
cont.c * expand tabs. 2019-07-08 16:00:29 +09:00
debug.c internal.h: remove dependecy on ruby/io.h 2018-01-09 06:24:10 +00:00
debug_counter.c Add debug counter for MJIT stale_units 2019-04-14 07:12:44 +00:00
debug_counter.h Reduce ONIG_NREGION from 10 to 4: power of 2 and testing revealed most pattern matches are less than or equal to 4 results 2019-05-07 21:58:55 +09:00
dir.c [DOC] fix markups [ci skip] 2019-03-22 11:04:59 +00:00
dln.c Remove IA64 support. 2019-06-19 23:30:04 +12:00
dln.h
dln_find.c
dmydln.c UNREACHABLE_RETURN 2018-07-24 05:38:07 +00:00
dmyenc.c
dmyext.c
encindex.h encoding.c: rb_enc_find_index2 2017-12-22 01:03:17 +00:00
encoding.c [DOC] fix markups [ci skip] 2019-03-22 11:04:59 +00:00
enum.c [DOC] Add link to Enumerable#grep from Enumerable#select 2019-07-09 13:01:11 +09:00
enumerator.c Remove duplicate functions 2019-06-21 17:53:32 +09:00
error.c * expand tabs. 2019-06-13 18:07:19 +09:00
eval.c * expand tabs. 2019-07-14 17:16:35 +09:00
eval_error.c eval_error.c: should not escapce newline and tab 2019-01-24 10:10:18 +00:00
eval_intern.h Use UNALIGNED_MEMBER_PTR 2019-05-31 16:04:16 +09:00
eval_jump.c `$SAFE` as a process global state. [Feature #14250] 2017-12-28 20:09:24 +00:00
file.c * expand tabs. 2019-07-14 17:16:35 +09:00
gc.c Make `stack_check` slightly easier to use in debugger. 2019-07-12 11:56:51 +12:00
gc.h * remove trailing spaces. 2019-07-12 15:02:25 +09:00
gem_prelude.rb
golf_prelude.rb golf_prelude.rb: suppress the redefining warning 2019-06-22 23:38:07 +09:00
goruby.c
hash.c Use rb_ident_hash_new instead of rb_hash_new_compare_by_id 2019-07-03 02:09:01 +09:00
hrtime.h hrtime.h: fix typo in non-builtin overflow check 2018-08-30 03:24:55 +00:00
id_table.c Add `GC.compact` again. 2019-04-20 01:19:47 +00:00
id_table.h Add `GC.compact` again. 2019-04-20 01:19:47 +00:00
inits.c Defer setting gc_stress until inits done 2019-04-24 13:02:01 +09:00
insns.def add definemethod/definesmethod insn. 2019-04-05 08:15:11 +00:00
internal.h socket: use frozen string buffer when releasing GVL 2019-07-14 20:46:51 +09:00
io.c io.c (rb_file_open_internal): initialize all the fields 2019-07-14 16:18:32 +09:00
iseq.c Use UNALIGNED_MEMBER_PTR 2019-05-31 16:04:16 +09:00
iseq.h Add `GC.compact` again. 2019-04-20 01:19:47 +00:00
lex.c.blt keywords: shrink struct kwtable 2018-01-21 09:59:45 +00:00
load.c Add a /* fall through */ comment 2019-07-14 17:32:53 +09:00
loadpath.c -Wno-overlength-strings 2018-01-16 08:35:33 +00:00
localeinit.c internal.h: remove dependecy on ruby/encoding.h 2018-01-09 06:24:11 +00:00
main.c
marshal.c * expand tabs. 2019-07-14 14:04:34 +09:00
math.c math.c: adjust cbrt 2018-06-06 14:01:43 +00:00
method.h STATIC_ASSERT for VM_METHOD_TYPE_MINIMUM_BITS 2019-05-31 10:55:38 +09:00
miniinit.c
mjit.c Rename rb_gc_new_location to rb_gc_location 2019-05-18 12:24:28 +03:00
mjit.h Rename mjit_gc_finish_hook to mjit_gc_exit_hook 2019-05-15 23:14:07 -07:00
mjit_compile.c Just disable inlining with local varaible for now 2019-07-03 10:39:22 +09:00
mjit_worker.c Fix a wrong buffer size to avoid stack corruption 2019-07-14 21:48:45 +09:00
node.c Fix grammar of macro name: ECCESSED -> ECCESSIVE 2019-06-05 14:03:50 +09:00
node.h Fix grammar of macro name: ECCESSED -> ECCESSIVE 2019-06-05 14:03:50 +09:00
numeric.c * expand tabs. 2019-07-14 17:16:35 +09:00
object.c Check exception flag as a bool [Bug #15987] 2019-07-11 20:04:29 +09:00
pack.c [DOC] fix markups [ci skip] 2019-03-28 03:33:35 +00:00
parse.y Add a /* fall through */ comment 2019-07-14 21:34:32 +09:00
prelude.rb [DOC] update target_thread to TracePoint#enable 2019-06-30 21:23:54 +09:00
probes.d
probes_helper.h vm.c: disable dtrace in jit source 2018-02-20 03:15:33 +00:00
proc.c Method#inspect with source location. 2019-07-14 15:46:07 +09:00
process.c process.c: [DOC] remove extra quotes [ci skip] 2019-03-30 12:37:23 +00:00
random.c * expand tabs. 2019-06-04 19:55:04 +09:00
range.c range.c (inspect_range): omit beginless "nil" 2019-05-23 00:48:32 +09:00
rational.c Check exception flag as a bool [Bug #15987] 2019-07-11 20:04:29 +09:00
re.c Remove member char_offset_updated from struct rmatch as member char_offset_num_allocated can serve the same purpose as that predicate 2019-04-24 02:02:05 +09:00
regcomp.c Fix issues detected by code analysis tool (mainly Coverity). 2018-09-15 09:59:14 +00:00
regenc.c
regenc.h initializer paren-string `{("str")}` is a C99ism 2018-01-02 06:41:49 +00:00
regerror.c Escape control codes in regexp warning message 2019-06-29 19:07:25 +09:00
regexec.c Only define history_root member of the Oniguruma re_registers struct if USE_CAPTURE_HISTORY is enabled 2019-04-24 00:40:17 +09:00
regint.h
regparse.c Fixed String#grapheme_clusters with wide encodings 2019-06-29 10:10:17 +09:00
regparse.h Fix typos. 2018-01-18 11:44:10 +00:00
regsyntax.c
ruby-runner.c Give the MJIT header path name 2018-12-08 01:50:39 +00:00
ruby.c * expand tabs. 2019-06-04 09:36:32 +09:00
ruby_assert.h Split RUBY_ASSERT and so on under include/ruby 2019-07-14 17:45:21 +09:00
ruby_atomic.h move atomic logic from mjit.c from ruby_atomic.h 2018-08-01 03:40:37 +00:00
rubystub.c
safe.c `$SAFE` as a process global state. [Feature #14250] 2017-12-28 20:09:24 +00:00
signal.c [DOC] fix markups [ci skip] 2019-03-28 03:33:35 +00:00
siphash.c
siphash.h blacklist UBSAN's unsigned integer overflow 2018-11-07 04:09:05 +00:00
sparc.c configure.ac 2017-09-29 13:21:17 +00:00
sprintf.c Add /* fall through */ comments 2019-07-14 14:04:19 +09:00
st.c Add `GC.compact` again. 2019-04-20 01:19:47 +00:00
strftime.c Prefer `rb_fstring_lit` over `rb_fstring_cstr` 2018-10-13 09:59:22 +00:00
string.c * expand tabs. 2019-07-14 17:16:35 +09:00
struct.c Define Struct#deconstruct 2019-04-17 06:48:05 +00:00
symbol.c Prefix global_symbols with `ruby_` 2019-05-16 15:43:16 +09:00
symbol.h Add RB_ID_SERIAL_MAX 2019-04-25 13:22:06 +09:00
thread.c [DOC] Re-apply r11000, 41256fd432 2019-06-28 23:21:25 +09:00
thread_pthread.c * expand tabs. 2019-06-19 20:33:24 +09:00
thread_pthread.h thread_pthread.h: rename `gvl.acquired' to `gvl.owner' and document 2018-08-28 00:24:08 +00:00
thread_sync.c do_mutex_lock: release mutex before checking for interrupts (fixes issue 15360) 2019-06-11 15:44:11 -07:00
thread_win32.c Remove IA64 support. 2019-06-19 23:30:04 +12:00
thread_win32.h
time.c Add a /* fall through */ comment 2019-07-14 14:28:01 +09:00
timev.h timev.h: dummy definition for TAGS 2019-04-10 12:43:31 +00:00
transcode.c Prefer rb_check_arity when 0 or 1 arguments 2018-12-06 07:49:24 +00:00
transcode_data.h
transient_heap.c prefix ASAN related inline functions asan_ 2019-05-23 17:24:53 +09:00
transient_heap.h Add `GC.compact` again. 2019-04-20 01:19:47 +00:00
util.c Split dtoa.c 2019-02-07 08:53:11 +00:00
variable.c Use rb_ident_hash_new instead of rb_hash_new_compare_by_id 2019-07-03 02:09:01 +09:00
version.c Update RDoc of RUBY_REVISION 2019-06-06 08:21:40 +09:00
version.h * 2019-07-14 2019-07-14 01:32:27 +09:00
vm.c MJIT Support for getblockparamproxy 2019-07-14 18:04:19 +09:00
vm_args.c update Array's length correctly. 2019-05-23 11:26:33 +09:00
vm_backtrace.c Handle (empty) backtrace when thread is not born yet. 2019-06-19 20:39:10 +12:00
vm_core.h Make export declaration place more consistent 2019-07-14 18:09:10 +09:00
vm_debug.h
vm_dump.c Remove IA64 support. 2019-06-19 23:30:04 +12:00
vm_eval.c Use rb_ident_hash_new instead of rb_hash_new_compare_by_id 2019-07-03 02:09:01 +09:00
vm_exec.c vm_exec.c: reduced repeated same calls 2018-03-04 01:52:19 +00:00
vm_exec.h use __GNUC__ instead of __GCC__. 2019-03-08 00:35:53 +00:00
vm_insnhelper.c Fix SystemStackError when calling a method in an unused refinement 2019-06-11 09:43:38 -07:00
vm_insnhelper.h Make export declaration place more consistent 2019-07-14 18:09:10 +09:00
vm_method.c * expand tabs. 2019-04-10 09:16:00 +00:00
vm_opts.h vm_opts.h: share USE_IC_FOR_IVAR as OPT_IC_FOR_IVAR 2018-10-14 11:25:36 +00:00
vm_trace.c Suppress warnings by gcc 9.1 2019-06-08 19:46:32 +09:00
vsnprintf.c give up sanitizing BSD_vfprintf 2019-04-26 15:59:40 +09:00
wercker.yml Generalize timeout_scale 2019-06-11 23:15:46 +09:00

README.md

Build Status wercker status Build status Build 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, Haiku, etc.) cf. https://github.com/ruby/ruby/blob/master/doc/contributing.rdoc#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 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. Optionally, run make update-gems and make extract-gems.

    If you want to install bundled gems, run make update-gems and make extract-gems before running make install.

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