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
Alan Wu 3c7251b41b Tally instructions when taking side exists for --ujit-stats


Co-authored-by: Maxime Chevalier-Boisvert <maxime.chevalierboisvert@shopify.com>
2021-10-20 18:19:28 -04:00
.github Disable install-doc at CodeQL 2021-10-14 20:13:09 +09:00
basictest
benchmark
bin
bootstraptest
ccan
coroutine Ignore dead threads in coroutine_join. 2021-07-02 12:36:14 +12:00
coverage
cygwin
defs
doc
enc
ext
gems Update bundled_gems at 2021-10-20 2021-10-20 07:07:22 +00:00
include
internal
lib
libexec
man
misc
missing
sample
spec Update to ruby/spec@254c380 2021-10-20 21:57:05 +02:00
template
test MicroJIT: avoid having to invalidate running output code 2021-10-20 18:19:26 -04:00
tool Tally instructions when taking side exists for --ujit-stats 2021-10-20 18:19:28 -04:00
win32 Refactor uJIT code into more files for readability 2021-10-20 18:19:26 -04:00
.appveyor.yml
.cirrus.yml Set the locale encoding to UTF-8 2021-09-28 00:52:18 +09:00
.dir-locals.el
.document
.editorconfig Remove duplicated and change order 2019-03-21 03:24:59 +00:00
.gdbinit
.gitattributes
.gitignore
.rspec_parallel
.travis.yml
aclocal.m4
addr2line.c
addr2line.h add #include guard hack 2020-04-13 16:06:00 +09:00
array.c
array.rb [DOC] Additional to Array#sample [ci skip] 2021-09-22 14:17:09 +09:00
ast.c ast.c: AST.of against C method should return nil (as Ruby 2.6--3.0) 2021-09-18 21:52:18 +09:00
ast.rb
autogen.sh autogen.sh: Make it work with sh (not bash) 2021-03-17 23:13:22 +09:00
bignum.c
BSDL
builtin.c
builtin.h
class.c
common.mk
compar.c
compile.c
complex.c
configure.ac
constant.h add #include guard hack 2020-04-13 16:06:00 +09:00
cont.c rb_fiber_raise(): add doxygen 2021-09-30 20:55:23 +13:00
CONTRIBUTING.md
COPYING
COPYING.ja
debug.c
debug_counter.c
debug_counter.h Add a cache for class variables 2021-06-18 10:02:44 -07:00
dir.c Using NIL_P macro instead of == Qnil 2021-10-03 22:34:45 +09:00
dir.rb Links for What's Here sections () 2021-09-13 10:37:15 -05:00
dln.c dln.c: add missing dependency 2021-09-10 20:00:06 +09:00
dln.h
dln_find.c Removed an unused declaration 2021-03-12 19:28:17 +09:00
dmydln.c
dmyenc.c
dmyext.c
encindex.h
encoding.c include/ruby/encoding.h: convert macros into inline functions 2021-10-05 14:18:23 +09:00
enum.c Accommondate earlier reviews of RDoc for Enumerable () 2021-10-06 19:06:17 -05:00
enumerator.c
error.c
eval.c Consider modified modules initialized [Bug ] 2021-09-24 08:29:00 +09:00
eval_error.c Trim extra whitespace in inaccesible error message 2021-09-01 13:18:55 +09:00
eval_intern.h Remove root_jmpbuf in rb_thread_struct 2021-08-10 19:08:38 +09:00
eval_jump.c Protoized old pre-ANSI K&R style declarations and definitions 2021-05-07 00:04:36 +09:00
file.c
gc.c
gc.h Enable inline assembly of SET_MACHINE_STACK_END on AIX 2021-10-04 23:06:43 -05:00
gc.rb
gem_prelude.rb
golf_prelude.rb
goruby.c
GPL
hash.c
hrtime.h
id_table.c
id_table.h
inits.c
insns.def
internal.h
io.c
io.rb [Feature ] Use Primitive.func style 2020-06-19 18:46:55 +09:00
iseq.c Add to the MicroJIT scraper an example that passes ec 2021-10-20 18:19:25 -04:00
iseq.h Add to the MicroJIT scraper an example that passes ec 2021-10-20 18:19:25 -04:00
kernel.rb
KNOWNBUGS.rb Remove known use-after-poison bug 2020-10-03 00:45:06 +09:00
LEGAL [DOC] Separate paragraph in LEGAL instead of break lines [ci skip] 2021-09-11 19:09:37 +09:00
lex.c.blt
load.c
loadpath.c -Wno-overlength-strings 2018-01-16 08:35:33 +00:00
localeinit.c
main.c
marshal.c
marshal.rb marshal.c Marshal.load accepts a freeze: true option. 2021-10-05 18:34:56 +02:00
math.c
memory_view.c
method.h prohibi method call by defined_method in other racotrs 2020-09-25 20:37:38 +09:00
mini_builtin.c
miniinit.c
mjit.c Revert "Pause an MJIT worker when JIT is cancelled" 2021-08-13 09:13:09 -07:00
mjit.h
mjit_compile.c
mjit_worker.c
NEWS.md
nilclass.rb Implemented some NilClass method in Ruby code is faster [Feature ] () 2021-06-02 20:04:56 -07:00
node.c
node.h node.h: Reduce struct size to fit with Ruby object size (five VALUEs) 2021-06-18 02:34:27 +09:00
numeric.c
numeric.rb
object.c
pack.c
pack.rb
parse.y Fix evaluation order of hash values for duplicate keys 2021-10-18 09:09:07 -07:00
prelude.rb Thread.exclusive: delete 2020-08-31 18:08:57 +09:00
probes.d
probes_helper.h
proc.c Refactor rb_proc_call function 2021-10-10 09:31:25 +09:00
process.c
ractor.c
ractor.rb
ractor_core.h Move rb_ractor_p definition 2021-10-04 08:21:40 +09:00
random.c
range.c
rational.c
re.c Using NIL_P macro instead of == Qnil 2021-10-03 22:34:45 +09:00
README.EXT
README.EXT.ja
README.ja.md [DOC] Move mailing-list URLs to footnotes [ci skip] 2021-07-11 20:12:45 +09:00
README.md
regcomp.c
regenc.c
regenc.h
regerror.c
regexec.c
regint.h
regparse.c Add printf-style format attribute to oniguruma functions 2021-09-27 19:02:45 +09:00
regparse.h Fix typos. 2018-01-18 11:44:10 +00:00
regsyntax.c
ruby-runner.c
ruby.c Report unknown --ujit-* options 2021-10-20 18:19:28 -04:00
ruby_assert.h
ruby_atomic.h Expose atomic operation macros with RUBY prefix 2020-12-24 11:43:21 +09:00
rubystub.c
scheduler.c
signal.c
siphash.c
siphash.h
sparc.c
sprintf.c
st.c
strftime.c
string.c Update documentation for String and Symbol to discuss differences 2021-10-15 13:54:03 -07:00
struct.c
symbol.c Fix STATIC_SYM2ID for large ID on IL32LLP64 platforms 2021-10-14 01:11:31 +09:00
symbol.h
test_asm.sh
thread.c Using NIL_P macro instead of == Qnil 2021-10-03 22:34:45 +09:00
thread_pthread.c include/ruby/internal/interpreter.h: add doxygen 2021-09-10 20:00:06 +09:00
thread_pthread.h Protoized old pre-ANSI K&R style declarations and definitions 2021-05-07 00:04:36 +09:00
thread_sync.c
thread_win32.c Function w32_error does not return 2021-10-04 08:15:52 +09:00
thread_win32.h
time.c
timev.h
timev.rb
trace_point.rb
transcode.c
transcode_data.h
transient_heap.c
transient_heap.h cancel theap on multi-ractors 2020-12-07 08:28:36 +09:00
ujit.h
ujit.rb Set T_FIXNUM type tags in opt_plus, opt_minus 2021-10-20 18:19:27 -04:00
ujit_asm.c
ujit_asm.h
ujit_asm_tests.c
ujit_codegen.c
ujit_codegen.h Declare instead of define data varaibles in header 2021-10-20 18:19:27 -04:00
ujit_core.c
ujit_core.h
ujit_iface.c Tally instructions when taking side exists for --ujit-stats 2021-10-20 18:19:28 -04:00
ujit_iface.h Tally instructions when taking side exists for --ujit-stats 2021-10-20 18:19:28 -04:00
ujit_utils.c
ujit_utils.h Added print_ptr() util function for debugging 2021-10-20 18:19:25 -04:00
util.c include/ruby/internal/ctype.h: add doxygen 2021-09-10 20:00:06 +09:00
variable.c
variable.h internal/*.h: skip doxygen 2021-09-10 20:00:06 +09:00
version.c
version.h * 2021-10-21 [ci skip] 2021-10-21 04:43:39 +09:00
vm.c
vm_args.c
vm_backtrace.c
vm_callinfo.h
vm_core.h Do not load file with same realpath twice when requiring 2021-10-02 05:51:29 -09:00
vm_debug.h Use RUBY_FUNCTION_NAME_STRING for old Visual C++ 2021-10-20 11:22:33 +09:00
vm_dump.c Shorten register names on arm64-darwin not to be truncated 2021-10-10 21:58:56 +09:00
vm_eval.c
vm_exec.c
vm_exec.h Fix compilation for -DUSE_INSNS_COUNTER 2021-10-20 18:19:24 -04:00
vm_insnhelper.c Remove useless casts 2021-10-19 17:09:32 +09:00
vm_insnhelper.h
vm_method.c Refactor uJIT code into more files for readability 2021-10-20 18:19:26 -04:00
vm_opts.h
vm_sync.c
vm_sync.h Adjusted indent [ci skip] 2021-02-09 08:41:06 +09:00
vm_trace.c Refactor rb_add_event_hook function 2021-09-29 09:16:53 +13:00
vsnprintf.c
warning.rb Use category: :deprecated in warnings that are related to deprecation 2020-12-18 09:54:11 -08:00

Actions Status: macOS Actions Status: MinGW Actions Status: MJIT Actions Status: Ubuntu Actions Status: Windows AppVeyor status Travis Status Cirrus 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, etc.) cf. https://github.com/ruby/ruby/blob/master/doc/contributing.rdoc#label-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 also 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.

Requirements to build from repository

  1. GNU or BSD make
  2. C99 compiler
  3. autoconf 2.67 or higher
  4. automake 1.15 or higher
  5. bison 2.3 or higher
  6. Ruby 2.2 or higher

When building from a released version, only a C99 compiler and GNU or BSD make is required.

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. Run ./autogen.sh to generate configure, when you build the source checked out from the Git repository.

  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 include/ruby/defines.h if you need. Usually this step will not be needed.

  5. Optional: Remove comment mark(#) before the module names from ext/Setup.

    This step is only necessary if you want to link modules statically.

    If you don't want to compile dynamic extensions (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. 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 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