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
zzak 308960a44e [DOC] Please see _the_ official issue tracker... [ci skip]
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@46423 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2014-06-13 23:42:35 +00:00
benchmark vm*: doubly-linked list from ccan to manage vm->living_threads 2014-05-10 23:48:51 +00:00
bin * bin/testrb: Removed. Forgot to remove in r45971. 2014-05-19 05:07:15 +00:00
bootstraptest bootstraptest/runner.rb: refine output 2014-06-10 14:11:57 +00:00
ccan vm*: doubly-linked list from ccan to manage vm->living_threads 2014-05-10 23:48:51 +00:00
cygwin
defs gmake.mk: fix argument 2014-06-01 21:50:32 +00:00
doc * lib/English.rb: [DOC] $LOADED_FEATURES moved to load.c [Fixes GH-620] 2014-05-31 19:54:55 +00:00
enc fix usage 2014-06-02 13:46:33 +00:00
ext digest.c: call to_s once 2014-06-07 03:29:00 +00:00
include configure.in, missing.h: jemalloc mangling 2014-06-05 05:16:46 +00:00
lib * lib/net/http/responses.rb: added Net::HTTPPermanentRedirect(308) 2014-06-12 09:32:36 +00:00
man * man/rake.1: [DOC] Update links for Rake, patch by @hsbt [Bug #9904] 2014-06-13 23:30:20 +00:00
misc * misc/README: use github link instead of rubyforge. 2014-06-05 03:47:46 +00:00
missing * missing/nextafter.c: Include ruby/missing.h. 2014-05-18 03:03:26 +00:00
nacl
sample * remove trailing spaces, append newline at EOF. 2013-12-25 03:46:08 +00:00
spec
symbian
template Doxyfile.tmpl: exclude ccan 2014-05-17 07:46:05 +00:00
test * vm_trace.c: add new method TracePoint.stat to debug 2014-06-13 09:01:21 +00:00
tool * tool/merger.rb: unlink temporary file explicitly. 2014-05-27 10:34:43 +00:00
win32 win32/setup.mak: rename RUBY_RELEASE_DATE 2014-06-10 08:30:10 +00:00
.document
.editorconfig
.gdbinit .gdbinit (rp): dump T_SYMBOL 2014-03-28 07:58:10 +00:00
.gitignore * ext/etc/etc.c: Etc.sysconf, Etc.confstr and IO#pathconf implemented. 2014-05-18 01:48:47 +00:00
.indent.pro
.travis.yml add uname -r 2014-04-23 05:31:08 +00:00
addr2line.c * addr2line.c (fill_lines): get base addrs in fill_lines to use it 2014-04-14 10:08:04 +00:00
addr2line.h * addr2line.c (fill_lines): loop reverse order not to overwrite 2014-03-26 04:30:43 +00:00
array.c array.c: combination on a shared copy 2014-06-13 08:34:17 +00:00
bignum.c * internal.h (struct RBignum): Use size_t for len. 2014-04-19 01:11:04 +00:00
BSDL
ChangeLog * man/rake.1: [DOC] Update links for Rake, patch by @hsbt [Bug #9904] 2014-06-13 23:30:20 +00:00
class.c * class.c: [DOC] Fixed grammar and examples of instance_methods. 2014-05-25 00:43:14 +00:00
common.mk constify character property tables 2014-05-22 05:02:15 +00:00
compar.c * compar.c (cmp_equal): warn for this release and still rescue 2014-01-18 21:40:58 +00:00
compile.c compile.c: use enum 2014-06-08 14:46:43 +00:00
complex.c avoid large alloca on Complex/Rational calls 2014-05-02 19:21:18 +00:00
configure.in thread.c: fix for non-scalar pthread_t 2014-06-11 08:38:09 +00:00
constant.h constant.h: reduce rb_const_entry_t size on 64-bit 2014-02-06 20:33:03 +00:00
cont.c cont.c : keep context.uc_stack.ss_sp and context.uc_stack.ss_size for later use. 2014-06-07 07:11:31 +00:00
CONTRIBUTING.md [DOC] Please see _the_ official issue tracker... [ci skip] 2014-06-13 23:42:35 +00:00
COPYING
COPYING.ja
debug.c * include/ruby/ruby.h: rename FL_OLDGEN to FL_PROMOTED. 2013-11-04 15:04:10 +00:00
dir.c encoding.h: constify rb_encoding 2014-06-02 20:23:47 +00:00
dln.c configure.in, missing.h: jemalloc mangling 2014-06-05 05:16:46 +00:00
dln.h dln.c: extra arguments 2013-06-30 01:58:51 +00:00
dln_find.c dln_find.c: PATH_SEP 2014-04-16 02:46:51 +00:00
dmydln.c
dmyext.c
encoding.c encoding.c: move ruby_encoding_index stuff 2014-06-02 20:23:52 +00:00
enum.c * enum.c: [DOC] Use #find in example to clarify alias by @rachellogie 2014-05-25 01:20:30 +00:00
enumerator.c * enumerator.c: [DOC] Fix example to show Enumerator#peek behavior 2014-05-25 03:00:17 +00:00
error.c encoding.h: constify rb_encoding 2014-06-02 20:23:47 +00:00
eval.c * eval.c (rb_using_refinement): add write-barriers for 2014-06-02 06:51:41 +00:00
eval_error.c eval_error.c: investigate core dump 2014-05-18 08:47:41 +00:00
eval_intern.h eval_intern.h: suppress warning by gcc 4.6 2014-05-28 05:39:45 +00:00
eval_jump.c eval_intern.h: VAR_INITIALIZED 2014-04-04 08:34:12 +00:00
file.c file.c: shrink expanded path 2014-06-12 04:09:41 +00:00
gc.c * gc.c: invoke GC before memory allocation (xmalloc/xrealloc) 2014-06-10 16:55:32 +00:00
gc.h * gc.c, gc.h (rb_objspace_each_objects_without_setup): 2014-04-02 11:59:50 +00:00
gem_prelude.rb
golf_prelude.rb * golf_prelude.rb: syntax formatting for whitespace [Fixes GH-425] 2013-11-07 16:03:48 +00:00
goruby.c * goruby.c (init_golf): append suffix. 2013-10-28 06:32:22 +00:00
GPL
hash.c use predefined IDs 2014-05-20 08:28:31 +00:00
ia64.s
inits.c ext/rbconfig/sizeof: move to an extension library 2013-11-18 14:19:16 +00:00
insns.def insns.def: fix typo 2014-05-26 15:00:23 +00:00
internal.h encoding.h: constify rb_encoding 2014-06-02 20:23:47 +00:00
io.c configure.in: disable posix_fadvise 2014-06-08 15:04:29 +00:00
iseq.c iseq.c: linear search 2014-01-12 07:49:26 +00:00
iseq.h * include/ruby/ruby.h (struct rb_data_type_struct), gc.c: add 2013-06-19 06:26:01 +00:00
KNOWNBUGS.rb
LEGAL * LEGAL: added license infomation of ccan files. 2014-05-14 02:07:32 +00:00
lex.c.blt
load.c * parse.y: support Symbol GC. [ruby-trunk Feature #9634] 2014-03-26 04:57:47 +00:00
loadpath.c * loadpath.c (RUBY_REVISION): Defined to suppress revision.h 2013-06-17 11:56:21 +00:00
localeinit.c localeinit.c: revert r46202 2014-05-28 23:35:43 +00:00
main.c
Makefile.in gmake.mk: universal assembler rules 2014-06-01 19:32:17 +00:00
marshal.c * internal.h (struct RBignum): Use size_t for len. 2014-04-19 01:11:04 +00:00
math.c configure.in: check atan2 2014-05-12 14:57:17 +00:00
method.h gc.c (rb_free_m_tbl): mark function as static 2014-05-22 20:17:48 +00:00
miniinit.c ext/rbconfig/sizeof: move to an extension library 2013-11-18 14:19:16 +00:00
NEWS Revert "* lib/yaml.rb: Remove Psych::EngineManager [Bug #8344]" 2014-05-25 03:33:22 +00:00
node.c node.c: indent 2014-04-25 07:12:58 +00:00
node.h node.h: remove NODE_PRIVATE_RECV 2014-06-06 13:19:31 +00:00
numeric.c * numeric.c (do_coerce): Add a warning when an exception is raised 2014-06-07 13:16:01 +00:00
object.c * object.c (rb_mod_initialize_clone): Override Kernel#initialize_clone 2014-06-07 02:41:01 +00:00
pack.c * compile.c (BUFSIZE): Unused macro removed. 2014-05-11 13:29:16 +00:00
parse.y node.h: remove NODE_PRIVATE_RECV 2014-06-06 13:19:31 +00:00
prelude.rb * prelude.rb: [DOC] Update Thread::exclusive docs by @stevenharman. 2014-04-17 07:31:43 +00:00
probes.d vm_method.c: add new ruby::method-cache-clear dtrace probe 2013-12-09 22:50:44 +00:00
probes_helper.h probes_helper.h (RUBY_DTRACE_HOOK): correct type for _id 2014-02-15 04:23:33 +00:00
proc.c proc.c: use already included ancestor iclass 2014-04-14 08:20:10 +00:00
process.c process.c (proc_getgroups, proc_setgroups): use ALLOCV_N 2014-05-24 07:22:54 +00:00
random.c * internal.h: Rename macro names: RBIGNUM_FOO to BIGNUM_FOO. 2014-02-15 21:17:34 +00:00
range.c range.c: unused function 2014-03-14 01:27:46 +00:00
rational.c * include/ruby/ruby.h: Hide Rational internal. 2014-05-17 16:37:41 +00:00
re.c re.c: consider name encoding 2014-06-04 13:09:57 +00:00
README.EXT * README.EXT: [DOC] Add rb_call_super when subclassing from @robin850 2014-06-02 16:38:31 +00:00
README.EXT.ja README.EXT: about string termination 2014-04-18 12:42:04 +00:00
README.ja.md * README.md, README.ja.md: removed (wrong) mode setting for emacs. 2014-02-24 12:42:45 +00:00
README.md * README.md, README.ja.md: removed (wrong) mode setting for emacs. 2014-02-24 12:42:45 +00:00
regcomp.c * regcomp.c (): Merge Onigmo 5.13.5 23b523076d6f1161. 2013-07-04 01:16:22 +00:00
regenc.c constify rb_encoding and OnigEncoding 2014-06-01 22:06:11 +00:00
regenc.h constify rb_encoding and OnigEncoding 2014-06-01 22:06:11 +00:00
regerror.c
regexec.c constify rb_encoding and OnigEncoding 2014-06-01 22:06:11 +00:00
regint.h
regparse.c
regparse.h
regsyntax.c
ruby.c + * ruby.c (load_file_internal2): Extracted from load_file_internal. 2014-06-03 14:33:51 +00:00
ruby_atomic.h iseq.c: potential memory leak 2014-01-12 07:41:10 +00:00
safe.c * include/ruby/intern.h, 2014-02-14 15:16:31 +00:00
signal.c signal.c: return proper member 2014-05-29 14:27:53 +00:00
siphash.c siphash.c: fix missing condition 2013-11-30 04:28:15 +00:00
siphash.h
sparc.c
sprintf.c encoding.h: constify rb_encoding 2014-06-02 20:23:47 +00:00
st.c configure.in, missing.h: jemalloc mangling 2014-06-05 05:16:46 +00:00
strftime.c
string.c string.c: consider capacity 2014-06-12 11:33:12 +00:00
struct.c struct.c: avoid pinning down 2014-03-28 12:36:27 +00:00
thread.c * vm_trace.c: clear and restore recursive checking thread local data 2014-06-13 08:50:11 +00:00
thread_pthread.c thread.c: fix for non-scalar pthread_t 2014-06-11 08:38:09 +00:00
thread_pthread.h * ext/openssl/depend: remove dependency from internal headers. 2014-05-14 10:55:38 +00:00
thread_win32.c thread_pthread.c: timer thread flag 2014-06-11 08:37:44 +00:00
thread_win32.h * ext/openssl/depend: remove dependency from internal headers. 2014-05-14 10:55:38 +00:00
time.c * compile.c (BUFSIZE): Unused macro removed. 2014-05-11 13:29:16 +00:00
timev.h configure.in, win32/Makefile.sub: PACKED_STRUCT with VC 2014-02-25 07:00:10 +00:00
transcode.c * transcode.c (str_transcode0): don't scrub invalid chars if 2013-11-22 08:50:14 +00:00
transcode_data.h
util.c util.c: let getcwd allocate buffer 2014-04-16 08:46:29 +00:00
variable.c variable.c, vm_method.c: pin down 2014-03-31 14:38:38 +00:00
version.c version.c: show malloc_conf 2014-06-05 05:36:28 +00:00
version.h * 2014-06-14 2014-06-13 23:30:25 +00:00
vm.c thread.c: fix for non-scalar pthread_t 2014-06-11 08:38:09 +00:00
vm_backtrace.c vm_backtrace.c: initialize flag 2014-01-24 07:17:17 +00:00
vm_core.h * vm_trace.c: clear and restore recursive checking thread local data 2014-06-13 08:50:11 +00:00
vm_debug.h
vm_dump.c report bug with machine regisiters 2014-05-25 03:46:55 +00:00
vm_eval.c * vm_eval.c: [DOC] [ci skip] Improve instance_eval description when given a 2014-05-24 21:52:31 +00:00
vm_exec.c * vm_exec.c (cfp): Fixes a SEGV issue in r44554. 2014-01-14 02:32:45 +00:00
vm_exec.h * vm_exec.h (VM_DEBUG_STACKOVERFLOW): added. 2013-12-18 05:33:50 +00:00
vm_insnhelper.c * vm.c (invoke_block_from_c): add VM_FRAME_FLAG_BMETHOD to record 2014-04-30 09:08:10 +00:00
vm_insnhelper.h * include/ruby/ruby.h: rename OBJ_WRITE and OBJ_WRITTEN into 2013-12-20 08:07:47 +00:00
vm_method.c variable.c, vm_method.c: pin down 2014-03-31 14:38:38 +00:00
vm_opts.h
vm_trace.c * vm_trace.c: add new method TracePoint.stat to debug 2014-06-13 09:01:21 +00:00
vsnprintf.c vsnprintf.c: fix string precision 2014-05-25 02:56:36 +00:00

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(ex. class, method calls)
  • Advanced Object-Oriented features(ex. Mix-in, Singleton-method)
  • Operator Overloading
  • Exception Handling
  • Iterators and Closures
  • Garbage Collection
  • Dynamic Loading of Object files(on some architecture)
  • Highly Portable (works on many Unix-like/POSIX compatible platforms as well as Windows, Mac OS X, BeOS etc.) cf. http://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:

http://www.ruby-lang.org/en/downloads/

The Ruby distribution files can be found in 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 http://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 and see the list of branches:

$ svn ls http://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:

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

Mailing list

There is a mailing list to talk about Ruby. To subscribe 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.in, 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 does 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.

  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 following directories and install files onto them.

    • ${DESTDIR}${prefix}/bin
    • ${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}
    • ${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}/${PLATFOR M}
    • ${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}/${P LATFORM}
    • ${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 (http://www.ruby-lang.org/en/community/mailing-lists) or on websites like (http://stackoverflow.com).

Bug reports should be filed at http://bugs.ruby-lang.org

The Author

Ruby was originally designed and developed by Yukihiro Matsumoto (Matz) in 1995.

mailto:matz@ruby-lang.org