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
Jeremy Evans 404850e134 Remove documentation that fatal cannot be rescued [ci skip]
You can rescue it:

f = ObjectSpace.each_object(Class){|c| break c if c.name == 'fatal'}
begin
  raise f
rescue f
  2
end # => 2

It's not a good idea to rescue fatal exceptions you didn't generate
yourself, though.

Fixes [Bug #10691]
2019-08-12 09:56:35 -07:00
.github/workflows Explain the current status of branches [ci skip] (#2350) 2019-08-13 01:45:10 +09:00
basictest colors file has been moved from test to tool 2019-07-02 09:19:38 +09:00
benchmark Close created files [ci skip] 2019-08-10 11:26:23 +09:00
bin Added binstub for racc executables. 2019-06-19 18:18:17 +09:00
bootstraptest bootstraptest/test_insns.rb: test opt_nil_p 2019-08-01 20:34:31 +09:00
ccan
coroutine Add assertions to coroutine_initialize_main. 2019-07-19 15:55:34 +12:00
coverage Fix typo 2019-05-21 14:23:42 +09:00
cygwin
defs Stop rewriting message to include PR URL 2019-08-13 00:48:52 +09:00
doc Use the word heredocs in Here Documents docs 2019-08-04 09:18:48 +09:00
enc Init function is need to link statically 2019-08-10 01:41:50 +09:00
ext date_parse.c: trim off 2019-08-12 20:41:11 +09:00
gems Update power_assert to 1.1.5 2019-08-11 11:01:39 +09:00
include rb_trap_exec has been removed since 1.9 2019-08-12 15:14:01 +09:00
lib Fix typo: duplicated the [skip-ci] 2019-08-09 16:23:49 -07:00
libexec [bundler/bundler] Revert "Migrate requires from exe/ to also be relative" 2019-08-03 09:29:56 +09:00
man Update IRB man page 2019-08-12 16:11:54 +09:00
misc add FROZEN to lldb debug output 2019-05-09 12:27:44 -07:00
missing
sample
spec Added example filter for Linux of GitHub Actions. 2019-08-12 12:14:39 +09:00
template test-bundled-gems-run: Respect -k option 2019-07-24 12:13:07 +09:00
test date_parse.c: avoid copying 2019-08-12 20:41:11 +09:00
tool Include commits notes in ChangeLog 2019-08-12 19:02:55 +09:00
win32 [DOC] "nmake check" is preferable to "nmake exam" now [ci skip] 2019-08-04 08:15:05 +09:00
.dir-locals.el
.document
.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/leaked-globals to .gitattributes [ci skip] 2019-07-15 13:45:14 +09:00
.gitignore Only ignore build directories. 2019-06-20 23:12:48 +12:00
.indent.pro
.travis.yml Simplify sudo specification 2019-08-12 20:20:59 +09:00
aclocal.m4
addr2line.c addr2line.c: clarify the type of integer expression 2019-07-15 08:38:37 +09:00
addr2line.h
appveyor.yml Debug which test hangs on mswin 2019-08-11 14:15:49 +09:00
array.c Allow Array#join to allocate smaller strings 2019-08-09 16:33:53 -07:00
ast.c Support memsize of AST 2019-07-23 16:22:53 +09:00
bignum.c * expand tabs. 2019-08-03 10:25:20 +09:00
BSDL
class.c remove useless include and dependency 2019-08-09 13:08:01 +09:00
common.mk gc.h is required on mswin build. 2019-08-09 14:11:24 +09:00
compar.c Clarify requirements of <=> 2019-04-22 17:15:49 +09:00
compile.c * expand tabs. 2019-08-09 01:32:30 +09:00
complex.c Expanded f_quo 2019-08-10 14:38:30 +09:00
configure.ac Relaxed target_os matching 2019-07-23 18:22:25 +09:00
constant.h Module#constant_source_location [Feature #10771] 2019-06-23 01:46:38 +09:00
cont.c Fix a typo [ci skip] 2019-08-13 01:03:14 +09:00
CONTRIBUTING.md
COPYING
COPYING.ja
debug.c
debug_counter.c Add a way to print debug counters without exiting 2019-08-07 10:36:17 -07:00
debug_counter.h Add a way to print debug counters without exiting 2019-08-07 10:36:17 -07:00
dir.c dir.c (dir_each_entry): remove unnecessary check 2019-07-15 00:10:11 +09:00
dln.c Remove IA64 support. 2019-06-19 23:30:04 +12:00
dln.h
dln_find.c
dmydln.c
dmyenc.c
dmyext.c
encindex.h
encoding.c Better wording for __ENCODING__ 2019-08-04 09:03:46 +09:00
enum.c enum.c: Remove unused #include 2019-08-07 22:24:20 +09:00
enumerator.c Use predefined idTo_proc 2019-08-01 16:40:03 +09:00
error.c Remove documentation that fatal cannot be rescued [ci skip] 2019-08-12 09:56:35 -07:00
eval.c Adjust documentation for Kernel#raise [ci skip] 2019-07-22 14:02:39 -07:00
eval_error.c Removed duplicate highlighting 2019-07-15 19:39:47 +09:00
eval_intern.h solve "duplicate :raise event" [Bug #15877] 2019-08-08 17:56:04 +09:00
eval_jump.c
file.c Do not always taint the result of File#path 2019-07-30 11:55:59 -07:00
gc.c also unpin final on weak maps 2019-08-12 12:34:09 -04:00
gc.h add rp() and bp() in internal.h. 2019-08-09 14:01:15 +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
GPL
hash.c hash.c: gc.h is needed when HASH_DEBUG mode 2019-08-07 22:54:38 +09:00
hrtime.h
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 Explicitly initialise encodings on init to remove branches on encoding lookup 2019-07-23 16:45:54 +09:00
insns.def leafify opt_plus 2019-08-06 20:59:19 +09:00
internal.h Expanded f_quo 2019-08-10 14:38:30 +09:00
io.c #include <> for system headers 2019-08-09 23:10:06 +09:00
iseq.c * expand tabs. 2019-08-13 01:34:36 +09:00
iseq.h Add GC.compact again. 2019-04-20 01:19:47 +00:00
KNOWNBUGS.rb
LEGAL
lex.c.blt
load.c Should require without wrapper module 2019-08-09 00:12:54 +09:00
loadpath.c
localeinit.c
main.c main.c: Add doxygen mainpage 2019-08-08 17:36:12 +09:00
marshal.c Warn instance variable E 2019-08-10 13:18:41 +09:00
math.c
method.h Stop packing rb_method_definition_t 2019-07-23 05:20:04 +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 Handle failure of opening a null device 2019-07-15 10:39:07 +09:00
NEWS Minor wording fix in NEWS [ci skip] 2019-08-12 19:13:38 +09:00
node.c Let memory sizes of the various IMEMO object types be reflected correctly 2019-07-23 16:22:34 +09:00
node.h Let memory sizes of the various IMEMO object types be reflected correctly 2019-07-23 16:22:34 +09:00
numeric.c Expanded f_quo 2019-08-10 14:38:30 +09:00
object.c Revert "Revert "Add a specialized instruction for .nil? calls"" 2019-08-02 23:25:38 +09:00
pack.c Added some examples to the documentation for String#unpack1 because 2019-08-09 17:06:07 -07:00
parse.y Fix parsing of mutiple assignment with rescue modifier 2019-08-09 09:25:30 -07:00
prelude.rb Document that non-blocking mode isn't always supported on Windows [ci skip] 2019-07-23 07:17:21 -07:00
probes.d
probes_helper.h
proc.c fix typos. 2019-07-14 22:04:27 +09:00
process.c nil as the default of optional parameters 2019-07-16 21:38:25 +09:00
random.c * expand tabs. 2019-06-04 19:55:04 +09:00
range.c Document that Range#cover? returns false if <=> returns nil 2019-07-24 10:35:28 -07:00
rational.c rb_numeric_quo: support Complex 2019-08-10 23:19:24 +09:00
re.c Reuse match data 2019-07-28 07:33:21 +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 README: Add smart URL for joining mailing list 2019-08-04 09:03:05 +09:00
regcomp.c
regenc.c
regenc.h
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
regsyntax.c
ruby-runner.c
ruby.c ruby.c (name_match_p): remove unnecessary condition 2019-07-14 21:58:22 +09:00
ruby_assert.h respect NDEBUG. 2019-07-19 12:04:32 +09:00
ruby_atomic.h
rubystub.c
safe.c
signal.c * expand tabs. 2019-08-01 14:27:19 +09:00
siphash.c
siphash.h
sparc.c
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
string.c Update docs to use more natural English 2019-08-12 12:21:37 -04: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 gc.h is required on mswin build. 2019-08-09 14:11:24 +09:00
thread_pthread.c * expand tabs. 2019-06-19 20:33:24 +09:00
thread_pthread.h
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 Refine time_to_r 2019-08-06 23:39:14 +09:00
timev.h timev.h: dummy definition for TAGS 2019-04-10 12:43:31 +00:00
transcode.c transcode.c (rb_econv_open0): remove unused code 2019-07-24 04:49:51 +09: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
variable.c remove RHash::iter_lev. 2019-07-31 09:44:23 +09:00
version.c Update RDoc of RUBY_REVISION 2019-06-06 08:21:40 +09:00
version.h * 2019-08-13 2019-08-13 00:51:04 +09:00
vm.c solve "duplicate :raise event" [Bug #15877] 2019-08-08 17:56:04 +09:00
vm_args.c update Array's length correctly. 2019-05-23 11:26:33 +09:00
vm_backtrace.c * expand tabs. 2019-08-01 16:04:09 +09:00
vm_core.h Revert "Revert "Add a specialized instruction for .nil? calls"" 2019-08-02 23:25:38 +09:00
vm_debug.h add rp() and bp() in internal.h. 2019-08-09 14:01:15 +09:00
vm_dump.c #include <> for system headers 2019-08-09 23:10:06 +09:00
vm_eval.c Revert "Revert "Fix dangling path name from fstring"" 2019-08-04 10:08:17 +09:00
vm_exec.c
vm_exec.h use __GNUC__ instead of __GCC__. 2019-03-08 00:35:53 +00:00
vm_insnhelper.c * expand tabs. 2019-08-09 11:11:18 +09:00
vm_insnhelper.h Initialize vm_throw_data::throw_state as int 2019-07-25 17:31:40 +09:00
vm_method.c Make attr* methods define public methods if self in caller is not same as receiver 2019-08-01 08:52:15 -07:00
vm_opts.h
vm_trace.c should not free local hook_list here. 2019-07-24 05:39:09 +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

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