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
stomar 6f33cde636 hash.c: improve docs for Hash#slice
* hash.c: [DOC] clarify description for Hash#slice and remove
  a sentence that might suggest that the receiver is modified;
  improve example to also include a case where a hash with
  several elements is returned.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@60713 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2017-11-07 20:17:04 +00:00
basictest
benchmark Lazy Proc allocation for block parameters 2017-10-24 11:13:49 +00:00
bin Update bundled bundler to 1.16.0. 2017-11-01 23:29:38 +00:00
bootstraptest show the location at intterrupted 2017-11-06 07:35:37 +00:00
ccan
coverage
cygwin
defs gmake.mk: order test-bundler 2017-09-21 12:26:16 +00:00
doc refinements.rdoc: improve docs 2017-11-07 20:04:58 +00:00
enc remove Unicode 9.0.0-related files 2017-09-06 08:12:02 +00:00
ext pathname.c: improve docs for Pathname 2017-11-07 20:14:46 +00:00
gems Update power_assert-1.1.1. It support test-bundled-gems. 2017-10-25 07:03:11 +00:00
include backward.h: rb_frame_method_id_and_class 2017-10-30 05:45:21 +00:00
lib http.rb: improve docs 2017-11-07 20:13:48 +00:00
man erb.1: add missing option in detailed description 2017-10-21 16:01:48 +00:00
misc ruby-additional.el: shorten here-doc markers 2017-10-02 04:06:55 +00:00
missing Drop to support NaCl platform. 2017-10-23 05:56:25 +00:00
sample Remove unnecessary require 'thread' 2017-10-08 07:00:01 +00:00
spec Modify spell miss. 2017-11-05 15:10:41 +00:00
template * node.h (ast_t): renamed to rb_ast_t. 2017-10-29 15:51:23 +00:00
test disable GC. 2017-11-07 14:23:58 +00:00
tool tool/runruby.rb: fix RUNRUBY_USE_GDB case 2017-11-07 11:21:09 +00:00
win32 Localize EC functions 2017-10-28 23:54:16 +00:00
.document Exclude Changelog files from documentation. 2017-09-01 03:34:18 +00:00
.editorconfig Add *.gemspec to .editorconfig [ci skip] 2017-09-12 11:15:27 +00:00
.gdbinit .gdbinit: follow up changes in r60440 2017-10-29 06:16:10 +00:00
.gitattributes rename ruby-runner as bin/ruby 2017-09-15 17:42:00 +00:00
.gitignore Removed obsoleted gitignore for test dependency. 2017-10-26 23:02:18 +00:00
.indent.pro
.travis.yml Regenerate slack token on Travis CI. 2017-10-25 09:24:37 +00:00
acinclude.m4
aclocal.m4 configure.ac 2017-09-29 13:21:17 +00:00
addr2line.c
addr2line.h
appveyor.yml Remove DevKit path, change zlib link 2017-09-27 21:55:32 +00:00
array.c common conversion functions 2017-10-26 07:23:23 +00:00
bignum.c bignum.c: avoid use of uninitialized value in Integer.sqrt 2017-11-02 06:30:18 +00:00
BSDL
class.c non-keywords hash 2017-08-20 06:08:25 +00:00
common.mk Should quote by double quotes, not single quotes for Windows 2017-11-02 03:12:05 +00:00
compar.c
compile.c Avoid usage of the magic number (NODE*)-1 2017-11-04 14:24:16 +00:00
complex.c complex.c: doc fix 2017-10-29 20:50:55 +00:00
configure.ac sysconfdir on Windows 2017-10-24 13:48:08 +00:00
constant.h
cont.c use GET_EC() directly. 2017-11-06 08:22:27 +00:00
CONTRIBUTING.md
COPYING
COPYING.ja
debug.c debug.c: vm call flags 2017-11-02 07:52:48 +00:00
debug_counter.c
debug_counter.h
dir.c dir.c: cast to suppress a warning 2017-11-01 01:55:45 +00:00
dln.c
dln.h
dln_find.c
dmydln.c
dmyenc.c
dmyext.c
encindex.h
encoding.c
enum.c enum.c: check argument first 2017-11-05 23:32:50 +00:00
enumerator.c Get rid of shadowing local variables 2017-10-18 04:35:25 +00:00
error.c EXEC_EVENT_HOOK(ec, ...) 2017-10-29 13:19:14 +00:00
eval.c th->ec: rb_threadptr_setup_exception 2017-11-07 06:09:47 +00:00
eval_error.c * eval_intern.h: rename macros rb_thread_raised_* to 2017-11-07 05:22:09 +00:00
eval_intern.h rb_execution_context_t * should not be th 2017-11-07 08:01:26 +00:00
eval_jump.c * eval_jump.c (rb_exec_end_proc): use GET_EC(). 2017-10-29 15:41:53 +00:00
file.c file.c: improve docs for File#path 2017-11-07 20:10:29 +00:00
gc.c * eval_intern.h: rename macros rb_thread_raised_* to 2017-11-07 05:22:09 +00:00
gc.h remove rb_threadptr_during_gc(). 2017-10-29 13:51:37 +00:00
gem_prelude.rb
golf_prelude.rb Use %i-literal instead of array of symbols 2017-09-07 12:31:50 +00:00
goruby.c
GPL
hash.c hash.c: improve docs for Hash#slice 2017-11-07 20:17:04 +00:00
ia64.s
id_table.c
id_table.h
inits.c
insns.def th->ec: dtrace 2017-11-07 08:19:25 +00:00
internal.h Rename imemo_strterm to imemo_parser_strterm 2017-11-04 10:56:50 +00:00
io.c io.c: improve docs for the chomp option 2017-11-02 20:38:04 +00:00
iseq.c use GET_EC() directly 2017-11-07 05:08:09 +00:00
iseq.h compile.c, iseq.c: consitfied NODE pointers 2017-10-27 12:00:38 +00:00
KNOWNBUGS.rb
LEGAL Removed ubygems.rb. rubygems.rb is always loaded now. 2017-09-24 07:52:25 +00:00
lex.c.blt
load.c th->ec: rb_load_internal0 2017-11-07 05:45:46 +00:00
loadpath.c
localeinit.c
main.c
Makefile.in Localize EC functions 2017-10-28 23:54:16 +00:00
marshal.c use rb_hash_new_with_size() 2017-10-01 04:26:25 +00:00
math.c
method.h Add doxygen comments 2017-10-21 14:31:21 +00:00
miniinit.c
NEWS NEWS: clarify "ubygems.rb" entry 2017-11-07 20:06:25 +00:00
node.c Introduce rb_code_location_t 2017-11-04 15:22:18 +00:00
node.h Revert "Introduce rb_code_range_t and replace YYLTYPE with it" 2017-11-05 03:52:22 +00:00
numeric.c complex.c: no overflow 2017-09-27 02:55:03 +00:00
object.c * object.c: Improve documentation of Kernel#Array 2017-10-21 23:44:15 +00:00
pack.c pack.c: unpack "M" may be ASCII only 2017-09-29 08:00:47 +00:00
parse.y lexer.rb: Ripper::Lexer::State 2017-11-05 21:13:18 +00:00
prelude.rb
probes.d
probes_helper.h th->ec: dtrace 2017-11-07 08:19:25 +00:00
proc.c proc.c: fix rdoc for Method class documentation 2017-11-02 20:23:47 +00:00
process.c move rb_thread_t::interrupt_flag and mask 2017-11-06 07:44:28 +00:00
random.c Random.urandom raises RuntimeError instead of returning nil 2017-09-13 12:46:13 +00:00
range.c range.c: use rb_check_funcall 2017-10-25 05:23:54 +00:00
rational.c freeze Complex and Rational 2017-10-19 10:58:08 +00:00
re.c [Feature #13712] String#start_with? supports regexp 2017-10-21 06:51:01 +00:00
README.EXT
README.EXT.ja
README.ja.md configure.ac 2017-09-29 13:21:17 +00:00
README.md README.md: fix typos and grammar 2017-11-07 20:07:33 +00:00
regcomp.c
regenc.c
regenc.h
regerror.c
regexec.c
regint.h
regparse.c
regparse.h
regsyntax.c
ruby-runner.c ruby-runner.c: RUBYLIB 2017-09-24 01:48:25 +00:00
ruby.c * node.h (ast_t): renamed to rb_ast_t. 2017-10-29 15:51:23 +00:00
ruby_assert.h
ruby_atomic.h
rubystub.c
safe.c call rb_vm_stack_to_heap() 2017-10-29 15:38:55 +00:00
signal.c move rb_thread_t::interrupt_flag and mask 2017-11-06 07:44:28 +00:00
siphash.c
siphash.h
sparc.c configure.ac 2017-09-29 13:21:17 +00:00
sprintf.c error.c: KeyError#receiver and KeyError#key 2017-09-18 08:05:53 +00:00
st.c st.c: fix num_entries 2017-09-05 07:52:08 +00:00
strftime.c
string.c string.c: improve docs for String#{concat,<<} 2017-11-07 20:15:59 +00:00
struct.c th -> ec for rb_insn_func_t. 2017-10-27 19:08:31 +00:00
symbol.c common conversion functions 2017-10-26 07:23:23 +00:00
symbol.h
thread.c Symptomatic treatment for rb_thread_terminate_all freeze 2017-11-07 06:36:07 +00:00
thread_pthread.c move rb_thread_t::interrupt_flag and mask 2017-11-06 07:44:28 +00:00
thread_pthread.h
thread_sync.c move rb_thread_t::interrupt_flag and mask 2017-11-06 07:44:28 +00:00
thread_win32.c * eval_intern.h: rename macros rb_thread_raised_* to 2017-11-07 05:22:09 +00:00
thread_win32.h
time.c Time#at receives 3rd argument which specifies the unit of 2nd argument [Feature #13919] 2017-09-25 06:20:10 +00:00
timev.h
transcode.c
transcode_data.h
util.c Drop to support NaCl platform. 2017-10-23 05:56:25 +00:00
variable.c
version.c
version.h * 2017-11-08 2017-11-07 20:04:59 +00:00
vm.c th->ec: dtrace 2017-11-07 08:19:25 +00:00
vm_args.c th is not used. 2017-11-07 08:23:57 +00:00
vm_backtrace.c * vm_backtrace.c (rb_debug_inspector_t): th -> ec. 2017-11-07 05:06:50 +00:00
vm_core.h rb_execution_context_t * should not be th 2017-11-07 08:01:26 +00:00
vm_debug.h
vm_dump.c vm_dump.c: [DOC] fix grammar 2017-11-07 20:11:44 +00:00
vm_eval.c th->ec: dtrace 2017-11-07 08:19:25 +00:00
vm_exec.c catch up recent changes for call threaded code VM. 2017-10-27 19:16:51 +00:00
vm_exec.h th -> ec for VM dump related functions. 2017-10-29 14:31:01 +00:00
vm_insnhelper.c th->ec: dtrace 2017-11-07 08:19:25 +00:00
vm_insnhelper.h * vm_insnhelper.h (GET_SP_COUNT): removed because nobody use it. 2017-10-29 15:34:20 +00:00
vm_method.c th -> ec for method management functions. 2017-10-28 12:23:51 +00:00
vm_opts.h
vm_trace.c * vm_trace.c (rb_exec_event_hooks): accepts pop_p. 2017-11-07 05:54:34 +00:00
vsnprintf.c

Build Status Build 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://bugs.ruby-lang.org/projects/ruby-trunk/wiki/SupportedPlatforms

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 Ruby distribution files can be found on the following FTP site:

ftp://ftp.ruby-lang.org/pub/ruby/

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 git://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 git://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 mailto: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.

mailto:matz@ruby-lang.org