development fork of ruby/ruby
Перейти к файлу
duerst 5a5dafb78e tweak syntax of Proc documentation [ci skip]
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@66398 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2018-12-14 05:44:41 +00:00
basictest
benchmark Add benchmark for hash small literals 2018-12-06 18:20:11 +00:00
bin Regenerated binstubs of bundler, rdoc and irb. 2018-11-28 03:10:09 +00:00
bootstraptest bootstraptest/runner.rb: increase timeout for --jit-wait 2018-12-12 00:38:49 +00:00
ccan ccan/list: sync with upstream 2018-02-01 08:59:27 +00:00
coroutine Ensure x86 stack is fortified, fixed #15335. 2018-12-11 23:49:33 +00:00
coverage
cygwin MFLAGS for nmake 2017-02-10 06:12:22 +00:00
defs Add separator for test/-ext- 2018-12-06 05:29:04 +00:00
doc range.c: Documentation on endless ranges. 2018-12-12 19:49:22 +00:00
enc implement special behavior for Georgian for String#capitalize 2018-12-09 23:14:29 +00:00
ext Suppress deprecation warnings 2018-12-14 04:10:42 +00:00
gems Bump rake-12.3.2 on bundled gems. 2018-12-07 10:00:21 +00:00
include complex.c: new APIs for Complex 2018-12-12 11:06:48 +00:00
lib No document of Tempfile::Remover [ci skip] 2018-12-14 03:36:13 +00:00
libexec Downgrade Bundler 1.17.x from 2.0.0. 2018-12-11 03:07:37 +00:00
man Downgrade Bundler 1.17.x from 2.0.0. 2018-12-11 03:07:37 +00:00
misc ruby-style.el: ruby-style-c-mode by VCS [ci skip] 2018-11-27 13:47:49 +00:00
missing [ci skip] tabify 2018-01-20 04:18:09 +00:00
sample Fix typo in trick2018/README [ci skip] 2018-12-03 10:35:13 +00:00
spec Merge Bundler 1.17.2 from upstream. 2018-12-11 11:02:41 +00:00
template Disable tailcall optimization [Bug #15303] 2018-12-12 05:46:13 +00:00
test Suppress deprecation warnings 2018-12-14 04:10:42 +00:00
tool Install script of default gems as is to its libexec dir 2018-12-13 10:51:59 +00:00
win32 win32/Makefile.sub: missing dependency of mjit_config.h 2018-12-10 02:58:01 +00:00
.document Include LEGAL in .document [ci skip] 2018-12-01 12:05:37 +00:00
.editorconfig Set indent_size of reg*.[ch] to 2 [ci skip] 2018-10-03 07:43:13 +00:00
.gdbinit support theap for T_HASH. [Feature #14989] 2018-10-30 22:11:51 +00:00
.gitattributes rename ruby-runner as bin/ruby 2017-09-15 17:42:00 +00:00
.gitignore Use BUILDDIR in ruby-runner.h from config.status 2018-12-08 01:49:02 +00:00
.indent.pro
.travis.yml .travis.yml: config_2nd may not exist in ~/ 2018-12-04 13:15:24 +00:00
BSDL
CONTRIBUTING.md
COPYING COPYING: expand tabs 2017-02-18 22:38:35 +00:00
COPYING.ja
GPL
KNOWNBUGS.rb compile.c: fix positions encode 2018-04-05 13:13:00 +00:00
LEGAL LEGAL: gathered util.c [ci skip] 2018-12-10 12:43:16 +00:00
Makefile.in Honor configured ruby header locations as the MJIT header path 2018-12-08 02:20:14 +00:00
NEWS NEWS: Fix description of BigDecimal.new [ci skip] 2018-12-14 03:45:32 +00:00
README.EXT
README.EXT.ja
README.ja.md [DOC] Added CI build status for Japanese docs 2018-07-31 17:11:00 +00:00
README.md README.md: add wercker status badge [ci skip] 2018-11-02 12:21:59 +00:00
aclocal.m4 Update aclocal to 1.16.1 [ci skip] 2018-10-05 03:25:33 +00:00
addr2line.c Show function name based on dladdr 2018-11-20 22:40:21 +00:00
addr2line.h Support Mach-O on backtrace with DWARF 2018-10-20 06:35:25 +00:00
appveyor.yml Try with TZInfo and Timezone gems 2018-11-28 14:08:34 +00:00
array.c rename li_table->ar_table (and related names). 2018-12-14 01:10:15 +00:00
ast.c Refine RubyVM::AbstractSyntaxTree::Node#type 2018-12-03 01:06:34 +00:00
bignum.c complex.c: rb_complex_new_polar 2018-12-12 11:06:47 +00:00
class.c Prefer rb_check_arity when 0 or 1 arguments 2018-12-05 01:09:44 +00:00
common.mk Use BUILDDIR in ruby-runner.h from config.status 2018-12-08 01:49:02 +00:00
compar.c
compile.c Don't increment `code_index` 2018-12-13 03:01:18 +00:00
complex.c complex.c: new APIs for Complex 2018-12-12 11:06:48 +00:00
configure.ac Native coroutine implementation for ppc64le Linux 2018-12-10 23:22:56 +00:00
constant.h vm_insnhelper.c: rb_autoloading_value flag 2018-02-13 09:34:43 +00:00
cont.c Avoid GCing dead stack after switching away from a fiber 2018-12-01 03:49:52 +00:00
debug.c internal.h: remove dependecy on ruby/io.h 2018-01-09 06:24:10 +00:00
debug_counter.c add debug counters more. 2018-09-28 01:10:43 +00:00
debug_counter.h rename li_table->ar_table (and related names). 2018-12-14 01:10:15 +00:00
dir.c Prefer rb_check_arity when 0 or 1 arguments 2018-12-05 01:09:44 +00:00
dln.c reduce copy & paste 2018-07-30 07:07:48 +00: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 encoding.c: check external encoding 2018-09-15 16:27:06 +00:00
enum.c Prefer rb_check_arity when 0 or 1 arguments 2018-12-06 07:49:24 +00:00
enumerator.c enumerator.c: Add rb_arithmetic_sequence_components_t 2018-12-12 07:16:07 +00:00
error.c Prefer rb_check_arity when 0 or 1 arguments 2018-12-06 07:49:24 +00:00
eval.c process.c: avoid dlclose before exec 2018-11-26 15:12:31 +00:00
eval_error.c eval_error.c: log10(0) is ERANGE 2018-11-15 09:03:03 +00:00
eval_intern.h reduce copy & paste 2018-07-30 07:07:48 +00:00
eval_jump.c `$SAFE` as a process global state. [Feature #14250] 2017-12-28 20:09:24 +00:00
file.c file.c: use correct integer-conversion function 2018-10-23 12:23:04 +00:00
gc.c rename li_table->ar_table (and related names). 2018-12-14 01:10:15 +00:00
gc.h remove rb_threadptr_during_gc(). 2017-10-29 13:51:37 +00:00
gem_prelude.rb
golf_prelude.rb added `f` for 1 byte FizzBuzz because Hexagony has such feature 2018-05-21 06:20:24 +00:00
goruby.c goruby.c: FD leak [ci skip] 2017-03-09 03:38:06 +00:00
hash.c separte NULL and EMPTY check. 2018-12-14 02:27:23 +00:00
hrtime.h hrtime.h: fix typo in non-builtin overflow check 2018-08-30 03:24:55 +00:00
ia64.S Change Makefile rule for assembly to use .S rather than .s 2018-11-24 11:35:29 +00:00
id_table.c adjust styles [ci skip] 2017-05-10 00:39:26 +00:00
id_table.h
inits.c initialize VM postponed_job first. [Bug #15288] 2018-11-08 05:35:46 +00:00
insns.def Speed up hash literals by duping 2018-12-06 18:28:21 +00:00
internal.h rename li_table->ar_table (and related names). 2018-12-14 01:10:15 +00:00
io.c io.c (io_fflush): eliminate redundant rb_io_check_closed 2018-12-06 10:41:07 +00:00
iseq.c Return same ISeq object for one src. 2018-12-06 10:52:27 +00:00
iseq.h `script_compiled` TracePoint event [Feature #15287] 2018-12-06 13:42:32 +00:00
lex.c.blt keywords: shrink struct kwtable 2018-01-21 09:59:45 +00:00
load.c `script_compiled` TracePoint event [Feature #15287] 2018-12-06 13:42:32 +00: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 main.c: RUBY_DEBUG_ENV in devel 2017-06-30 04:19:12 +00:00
marshal.c avoid division by zero 2018-11-16 01:52:39 +00:00
math.c math.c: adjust cbrt 2018-06-06 14:01:43 +00:00
method.h Revert "Symbol refinements" 2018-12-04 04:22:08 +00:00
miniinit.c
mjit.c Removed never-happening case 2018-12-09 01:22:16 +00:00
mjit.h vm_trace.c: MJIT-limited thread-safety for postponed_job 2018-11-26 15:47:20 +00:00
mjit_compile.c mjit.c: copy call cache values to MJIT worker 2018-10-21 14:23:24 +00:00
mjit_worker.c Enable MJIT on AIX 2018-12-04 22:19:09 +00:00
node.c Removed unreachable code 2018-10-12 12:54:21 +00:00
node.h Parse the source in SCRIPT_LINES__ as array 2018-11-10 11:40:33 +00:00
numeric.c complex.c: rb_complex_new_polar 2018-12-12 11:06:47 +00:00
object.c Show the class of the receiver [Feature #15231] 2018-12-06 23:03:54 +00:00
pack.c pack.c: cast from double to float can be undefined 2018-11-16 09:04:34 +00:00
parse.y Fix locations of NODE_UNDEF in undef with multiple args 2018-11-25 12:31:35 +00:00
prelude.rb `TracePoint#enable(target_line:)` is supported. [Feature #15289] 2018-11-26 20:16:14 +00:00
probes.d
probes_helper.h vm.c: disable dtrace in jit source 2018-02-20 03:15:33 +00:00
proc.c tweak syntax of Proc documentation [ci skip] 2018-12-14 05:44:41 +00:00
process.c process.c (retry_fork_async_signal_safe): fix -Wclobbered 2018-12-04 01:41:55 +00:00
random.c suppress integer overflow warnings 2018-11-13 00:40:52 +00:00
range.c range.c: [DOC] fix typo 2018-12-12 22:03:11 +00:00
rational.c Prefer rb_check_arity when 0 or 1 arguments 2018-12-06 07:49:24 +00:00
re.c re.c: [DOC] fix typos 2018-12-13 20:25:36 +00:00
regcomp.c Fix issues detected by code analysis tool (mainly Coverity). 2018-09-15 09:59:14 +00:00
regenc.c Merge Onigmo 6.1.1 2017-02-11 15:08:33 +00:00
regenc.h initializer paren-string `{("str")}` is a C99ism 2018-01-02 06:41:49 +00:00
regerror.c regerror.c: lenghten MAX_ERROR_PAR_LEN to contain old property names 2018-10-16 09:10:56 +00:00
regexec.c label as lvalue is a GCCism 2018-01-02 06:41:54 +00:00
regint.h Merge Onigmo 6.1.1 2017-02-11 15:08:33 +00:00
regparse.c convert check for array length to assertion and comment out 2018-12-07 07:20:26 +00:00
regparse.h Fix typos. 2018-01-18 11:44:10 +00:00
regsyntax.c Merge Onigmo 6.0.0 2016-12-10 17:47:04 +00:00
ruby-runner.c Give the MJIT header path name 2018-12-08 01:50:39 +00:00
ruby.c ruby.c: do not surface MJIT to user 2018-11-19 14:00:49 +00:00
ruby_assert.h string literal longer than 509 characters is a C99ism 2018-01-02 06:41:43 +00: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 Prefer rb_check_arity when 0 or 1 arguments 2018-12-06 07:49:24 +00:00
siphash.c switch SipHash from SipHash24 to SipHash13 variant 2017-01-20 06:01:23 +00:00
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 sprintf.c: fix typo 2018-04-22 19:41:06 +00:00
st.c Adjust reserved hash values 2018-12-07 12:03:16 +00:00
strftime.c Prefer `rb_fstring_lit` over `rb_fstring_cstr` 2018-10-13 09:59:22 +00:00
string.c string.c: [DOC] fix typos 2018-12-12 22:04:48 +00:00
struct.c * expand tabs. 2018-11-05 08:02:31 +00:00
symbol.c symbol.c: dsymbol initial encoding 2018-06-28 07:34:36 +00:00
symbol.h symbol.h: remove stale symbol deleted at r47913 2018-04-06 13:25:11 +00:00
thread.c Prefer rb_check_arity when 0 or 1 arguments 2018-12-06 07:49:24 +00:00
thread_pthread.c thread_pthread.c (native_ppoll_sleep): drop ubf_select references 2018-12-13 09:41:17 +00: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 Prefer rb_check_arity when 0 or 1 arguments 2018-12-06 07:49:24 +00:00
thread_win32.c add disabling MJIT features option. 2018-10-20 06:53:00 +00:00
thread_win32.h
time.c time.c: improve docs for Time 2018-12-13 22:41:44 +00:00
timev.h Timezone support by Time [Feature #14850] 2018-10-08 02:35: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 rename li_table->ar_table (and related names). 2018-12-14 01:10:15 +00:00
transient_heap.h introduce USE_TRANSIENT_HEAP to enable/disable theap. 2018-11-01 08:53:44 +00:00
util.c suppress integer overflow warnings 2018-11-15 07:34:01 +00:00
variable.c Prefer rb_check_arity when 0 or 1 arguments 2018-12-06 07:49:24 +00:00
version.c add disabling MJIT features option. 2018-10-20 06:53:00 +00:00
version.h * 2018-12-14 2018-12-13 20:24:25 +00:00
vm.c Return same ISeq object for one src. 2018-12-06 10:52:27 +00:00
vm_args.c Revert "Symbol refinements" 2018-12-04 04:22:08 +00:00
vm_backtrace.c Make some internal functions static 2018-11-16 06:52:00 +00:00
vm_core.h Return same ISeq object for one src. 2018-12-06 10:52:27 +00:00
vm_debug.h
vm_dump.c * expand tabs. [ci skip] 2018-11-07 12:48:39 +00:00
vm_eval.c `script_compiled` TracePoint event [Feature #15287] 2018-12-06 13:42:32 +00:00
vm_exec.c vm_exec.c: reduced repeated same calls 2018-03-04 01:52:19 +00:00
vm_exec.h fix typo. 2018-09-21 06:30:54 +00:00
vm_insnhelper.c Return same ISeq object for one src. 2018-12-06 10:52:27 +00:00
vm_insnhelper.h vm_insnhelper.h: rename CI_SET_FASTPATH to CC_SET_FASTPATH 2018-09-18 12:48:28 +00:00
vm_method.c Warn redefinitions of some methods on Object 2018-12-06 23:06:13 +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 remove `compiled_` prefix. [Feature #15287] 2018-12-12 15:45:06 +00:00
vsnprintf.c avoid division by zero 2018-11-16 01:52:39 +00:00
wercker.yml wercker.yml: debug problematic test on test-all 2018-11-18 09:32:29 +00:00

README.md

Build Status Build status wercker status

What's Ruby

Ruby is the interpreted scripting language for quick and easy object-oriented programming. It has many features to process text files and to do system management tasks (as in Perl). It is simple, straight-forward, 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/trunk/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/

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

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

Or if you are using git then use 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:

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

Or if you are using git then use the following command:

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

Ruby home page

The URL of the Ruby home page is:

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

Mailing list

There is a mailing list to talk about 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

This is what you need to do to compile and install Ruby:

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

Bug reports should be filed 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