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
nobu 1a65cef0f0 doc: remove trailing spaces
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@47689 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2014-09-23 00:13:32 +00:00
benchmark bm_app_aobench.rb: update links [ci skip] 2014-09-16 10:18:53 +00:00
bin * bin/testrb: Removed. Forgot to remove in r45971. 2014-05-19 05:07:15 +00:00
bootstraptest wait until the thread is stopped. 2014-09-21 04:54:46 +00:00
ccan ccan/container_of: add container_of_or_null 2014-09-13 23:49:28 +00:00
coverage fix a typo [ci skip] 2014-09-12 12:17:29 +00:00
cygwin
defs * defs/default_gems: change version definition file of rake. 2014-07-15 03:43:04 +00:00
doc doc: remove trailing spaces 2014-09-23 00:13:32 +00:00
enc Re-apply r43023 which is accidentally reverted by r47598 2014-09-17 14:53:08 +00:00
ext ext/socket/*.c: trivial struct packing for 64-bit 2014-09-22 00:46:25 +00:00
gems * gems/bundled_gems: Upgraded to test-unit-3.0.1 and minitest-5.4.1 2014-09-12 05:40:01 +00:00
include intern.h: rb_str_new_literal 2014-09-19 05:53:05 +00:00
lib tmpdir.rb: explicit conversion to string 2014-09-22 04:44:19 +00:00
man man/ruby.1: use https for *.ruby-lang.org links 2014-09-13 00:48:36 +00:00
misc ruby-additional.el: change key 2014-07-29 07:41:42 +00:00
missing * missing/nextafter.c: Include ruby/missing.h. 2014-05-18 03:03:26 +00:00
nacl * nacl/nacl-config.rb: Use File.exist? instead of executable? 2014-06-23 20:53:16 +00:00
sample * lib/rinda/ring.rb: split executable code into sample directory. 2014-08-21 04:23:56 +00:00
spec * remove trailing spaces. 2014-08-17 23:04:23 +00:00
template vm.inc.tmpl + instruction.rb: typo fixes 2014-09-14 07:58:25 +00:00
test Fix a typo. 2014-09-22 23:29:15 +00:00
tool add .tar.xz 2014-09-18 01:30:09 +00:00
win32 Makefile.sub: fix typo 2014-09-19 07:04:35 +00:00
.document
.editorconfig
.gdbinit follow RIncGC 2014-09-12 14:16:57 +00:00
.gitignore * .gitignore: ignored temporary files and coverage results. 2014-09-11 09:40:21 +00:00
.indent.pro
.travis.yml * .travis.yml: Only osx build is enabled. linux builds is random failure 2014-09-22 09:21:39 +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: GC guard 2014-09-22 08:17:24 +00:00
bignum.c add some documents [ci skip] 2014-07-28 11:28:55 +00:00
BSDL
ChangeLog test/win32ole/test_win32ole_variant.rb 2014-09-22 11:01:22 +00:00
class.c class.c: do not freeze class of hidden object 2014-09-19 02:40:58 +00:00
common.mk * common.mk (encs enc trans libencs libenc libtrans): force to run 2014-09-10 05:16:21 +00:00
compar.c compar.c: use Module#to_s 2014-08-21 04:39:32 +00:00
compile.c compile.c: store IDs as Symbols 2014-09-20 01:23:02 +00:00
complex.c provide backward compatibilities 2014-08-22 08:01:42 +00:00
configure.in configure.in: use ac_cv_func_vfork 2014-09-07 02:04:16 +00:00
constant.h variable: cleanup to use rb_const_lookup 2014-08-04 01:12:53 +00:00
cont.c rb_{thread,context,fiber}_struct: trivial packing 2014-08-15 00:25:34 +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 follow RIncGC 2014-09-12 14:16:57 +00:00
dir.c * configure.in (dirfd): Check function. 2014-09-04 15:54:04 +00:00
dln.c * symbian/*: removed Symbian support. 2014-09-04 11:09:32 +00:00
dln.h
dln_find.c dln_find.c: PATH_SEP 2014-04-16 02:46:51 +00:00
dmydln.c
dmyext.c
encoding.c symbols instead of IDs 2014-07-28 08:15:42 +00:00
enum.c * enum.c (enum_chunk): Deprecate the state management. 2014-09-20 15:01:44 +00:00
enumerator.c * enum.c (enum_slice_when): New method: Enumerable#slice_when. 2014-09-20 06:52:29 +00:00
error.c error.c: preserve encoding 2014-09-19 01:46:42 +00:00
eval.c eval.c: fix message as same as previous versions 2014-09-13 01:22:01 +00:00
eval_error.c eval_error.c: quote unprintable 2014-07-26 16:13:33 +00:00
eval_intern.h eval_error.c: rb_print_inaccessible 2014-07-26 16:13:21 +00:00
eval_jump.c eval_intern.h: VAR_INITIALIZED 2014-04-04 08:34:12 +00:00
file.c file.c: clear tmp buffer on failures 2014-09-21 03:26:47 +00:00
gc.c compile.c, gc.c: suppress warnings 2014-09-14 01:56:53 +00:00
gc.h * gc.c: rename is_dying_object() to is_garbage_object(). 2014-07-06 15:42:14 +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: suppress warning 2014-08-10 04:48:10 +00:00
GPL
hash.c hash.c: [DOC] fix for Hash#store docs 2014-09-13 13:19:27 +00:00
ia64.s
inits.c vm_method.c: configurable global method cache size 2014-09-18 00:36:37 +00:00
insns.def iseq_inline_storage_entry: 24=>16 bytes on 64-bit 2014-09-11 19:25:32 +00:00
internal.h readline.c: use rb_setup_fake_str 2014-09-12 13:11:13 +00:00
io.c trivial packing for on-stack structs 2014-09-15 07:31:38 +00:00
iseq.c iseq.c (rb_iseq_defined_string): trim redundant semi-colon 2014-09-21 03:50:23 +00:00
iseq.h compile: translate iseq in-place 2014-09-10 06:14:07 +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: change Symbol <-> ID relationship to avoid 2014-07-09 06:14:41 +00:00
loadpath.c
localeinit.c localeinit.c: revert r46202 2014-05-28 23:35:43 +00:00
main.c
Makefile.in * Makefile.in (update-coverage): Remove a never executed line. 2014-09-02 13:04:04 +00:00
marshal.c marshal.c: fix symlink index 2014-07-29 03:28:43 +00:00
math.c constify parameters 2014-06-18 06:16:39 +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 * enum.c (enum_chunk): Deprecate the state management. 2014-09-20 15:01:44 +00:00
node.c * st.c (numberof): unused. internal.h has same macro. 2014-09-21 09:22:42 +00:00
node.h node.h: extract NODE functions from gc.c 2014-08-16 01:53:10 +00:00
numeric.c * dir.c (glob_helper): use #ifdef instead of #if. 2014-09-04 08:50:31 +00:00
object.c * include/ruby/ruby.h: freeze nil/true/false. 2014-09-11 05:37:32 +00:00
pack.c pack.c: no nil.taint 2014-09-10 08:04:59 +00:00
parse.y * parse.y (parser_class_nest): unused variable after YARV 2014-09-21 09:52:37 +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/env DATA_PTR is never NULL 2014-09-12 21:34:12 +00:00
process.c trivial packing for on-stack structs 2014-09-15 07:31:38 +00:00
random.c random.c: fix casts 2014-07-09 14:51:26 +00:00
range.c range.c: unused function 2014-03-14 01:27:46 +00:00
rational.c provide backward compatibilities 2014-08-22 08:01:42 +00:00
re.c get rid of function calls in RSTRING_PTR 2014-07-30 13:46:41 +00:00
README.EXT intern.h: rb_str_new_literal 2014-09-19 05:53:05 +00:00
README.EXT.ja intern.h: rb_str_new_literal 2014-09-19 05:53:05 +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: fix slight grammatical error by @abwinkler999. 2014-07-13 07:38:47 +00:00
regcomp.c * reg*.c: Merge Onigmo 5.15.0 38a870960aa7370051a3544 2014-09-15 16:18:41 +00:00
regenc.c * reg*.c: Merge Onigmo 5.15.0 38a870960aa7370051a3544 2014-09-15 16:18:41 +00:00
regenc.h regenc.h: shrink PosixBracketEntryType 2014-09-16 02:44:19 +00:00
regerror.c * regcomp.c: Merge Onigmo 5.14.1 25a8a69fc05ae3b56a09. 2014-07-16 03:27:25 +00:00
regexec.c * reg*.c: Merge Onigmo 5.15.0 38a870960aa7370051a3544 2014-09-15 16:18:41 +00:00
regint.h * reg*.c: Merge Onigmo 5.15.0 38a870960aa7370051a3544 2014-09-15 16:18:41 +00:00
regparse.c regparse.c: remove unused variable 2014-09-16 02:44:10 +00:00
regparse.h * reg*.c: Merge Onigmo 5.15.0 38a870960aa7370051a3544 2014-09-15 16:18:41 +00:00
regsyntax.c
ruby.c ruby.c: reduce RARRAY_PTR_USE region 2014-08-23 02:52:23 +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: SIGEXIT is not a system signal 2014-09-21 05:10:14 +00:00
siphash.c UNALIGNED_WORD_ACCESS on ppc64 2014-07-23 14:50:12 +00:00
siphash.h
sparc.c
sprintf.c sprintf.c: integer overflow 2014-09-16 02:44:04 +00:00
st.c * st.c (do_hash_bin): unused macro. 2014-09-21 10:07:44 +00:00
strftime.c
string.c string.c: rb_str_new_static 2014-09-19 05:53:00 +00:00
struct.c struct.c: no rb_class_real twice 2014-08-21 04:39:28 +00:00
symbol.c symbol.c: fix dynamic attrset ID 2014-09-19 11:06:04 +00:00
symbol.h symbol.c: move macros 2014-08-04 01:05:09 +00:00
thread.c * thread_pthread.c (native_set_thread_name): New function to 2014-09-21 05:14:47 +00:00
thread_pthread.c * thread_pthread.c (native_set_thread_name): New function to 2014-09-21 05:14:47 +00:00
thread_pthread.h thread_pthread: prefer rb_nativethread* types/functions 2014-08-15 00:17:53 +00:00
thread_win32.c * thread_pthread.c (native_set_thread_name): New function to 2014-09-21 05:14:47 +00:00
thread_win32.h * ext/openssl/depend: remove dependency from internal headers. 2014-05-14 10:55:38 +00:00
time.c * time.c: raise exception when minutes of utc_offset is out of 00-59. 2014-09-21 16:58:47 +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: use string 2014-08-03 01:55:32 +00:00
transcode_data.h
util.c util.c: let getcwd allocate buffer 2014-04-16 08:46:29 +00:00
variable.c simplify some trivial rb_data_type_t callbacks 2014-09-13 05:14:51 +00:00
version.c version.c: show malloc_conf 2014-06-05 05:36:28 +00:00
version.h * 2014-09-23 2014-09-22 23:29:27 +00:00
vm.c vm.c (thread_alloc): remove needless volatile 2014-09-12 21:34:25 +00:00
vm_backtrace.c simplify some trivial rb_data_type_t callbacks 2014-09-13 05:14:51 +00:00
vm_core.h proc.c (rb_proc_alloc): inline and move to vm.c 2014-09-12 20:57:45 +00:00
vm_debug.h
vm_dump.c compile: translate iseq in-place 2014-09-10 06:14:07 +00:00
vm_eval.c vm_eval.c: fix super from eval with scope 2014-09-19 22:55:59 +00:00
vm_exec.c * vm_exec.c: improve performance in ppc64 arch. 2014-08-12 03:59:39 +00:00
vm_exec.h * vm_exec.h (VM_DEBUG_STACKOVERFLOW): added. 2013-12-18 05:33:50 +00:00
vm_insnhelper.c variable.c: check index overflow 2014-09-10 08:05:12 +00:00
vm_insnhelper.h vm_core.h: redefined_flag in rb_vm_t 2014-07-18 01:53:18 +00:00
vm_method.c vm_method.c: configurable global method cache size 2014-09-18 00:36:37 +00:00
vm_opts.h
vm_trace.c * process.c (rlimit_resource_type, rlimit_resource_value): 2014-07-30 13:17:45 +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 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.

  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