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
hsbt ae0e680769 * lib/optparse.rb: improvements for OptionParser documentation.
[misc #10608][ruby-core:66901][ci skip]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@49218 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2015-01-12 04:37:12 +00:00
benchmark * array.c: Improve performance of Array#shift. use shared instead of 2015-01-03 02:27:50 +00:00
bin erb: suppress warnings 2014-12-12 19:59:22 +00:00
bootstraptest normalize reference to Timeout::Error 2014-10-07 20:00:09 +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 GNUmakefile.in: append resources always 2014-12-28 07:25:15 +00:00
defs id.def: move IDs for exception 2014-11-16 08:33:35 +00:00
doc * doc/regexp.rdoc: fix regexp docs for whitespace character. 2015-01-01 12:41:54 +00:00
enc Update dependencies. 2014-12-19 13:34:54 +00:00
ext [DOC] 2015-01-11 15:58:40 +00:00
gems * gems/bundled_gems: Upgrade to test-unit 3.0.8. assert_throw and 2014-12-12 13:00:15 +00:00
include intern.h: rb_str_new_literal 2015-01-03 10:52:14 +00:00
lib * lib/optparse.rb: improvements for OptionParser documentation. 2015-01-12 04:37:12 +00:00
man GC documentation update 2014-12-15 22:39:33 +00:00
misc ruby-additional.el: change key 2014-07-29 07:41:42 +00:00
missing missing/setproctitle.c: Avoid invalidating argv[1], argv[2], etc. until the first call to Process.setproctitle, because the ps command of AIX refers to the argv array. [Bug #10090] 2014-10-08 22:31:53 +00:00
nacl Fix PNaCl configure/link errors. 2014-10-22 12:19:21 +00:00
sample fix a typo in comment [ci skip] 2014-11-09 13:12:21 +00:00
spec * remove trailing spaces. 2014-08-17 23:04:23 +00:00
template configure.in: fix --with-ruby-version [ci skip] 2014-12-05 21:14:25 +00:00
test array.c: class name encoding 2015-01-11 23:48:10 +00:00
tool add bold to headers 2015-01-06 01:19:01 +00:00
win32 never-NULL pointer check 2014-12-26 05:51:36 +00:00
.document
.editorconfig
.gdbinit .gdbinit: update for r47913 2014-11-17 21:08:23 +00:00
.gitignore fiddle: extlibs 2014-12-23 13:39:13 +00:00
.indent.pro
.travis.yml * .travis.yml: Remove redundant configuration option. 2015-01-08 02:39:23 +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 (rb_ary_each): documented return value. 2015-01-12 04:33:57 +00:00
bignum.c * internal.h: Include ruby.h and ruby/encoding.h to be 2014-11-15 11:49:06 +00:00
BSDL
ChangeLog * lib/optparse.rb: improvements for OptionParser documentation. 2015-01-12 04:37:12 +00:00
class.c * class.c (class_alloc): Strat from age == 2. 2014-12-11 10:15:30 +00:00
common.mk * common.mk (up): propagate verbose option. 2014-12-24 02:56:32 +00:00
compar.c compar.c: use Module#to_s 2014-08-21 04:39:32 +00:00
compile.c parse.y: eliminate empty hashes 2015-01-09 02:13:03 +00:00
complex.c * complex.c: removed commented-out code. 2015-01-10 01:58:59 +00:00
configure.in extmk.rb: default without-ext 2015-01-11 04:44:09 +00:00
constant.h constant.h: constant visibilities 2014-10-08 08:27:51 +00:00
cont.c * vm_core.h: introduce new field 2014-12-10 19:35:07 +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 rb_id2str over rb_id2name 2014-11-25 18:44:22 +00:00
dir.c dir.c: OSX case-folding 2015-01-08 03:53:45 +00:00
dln.c Merges a patch form naclports. 2014-10-11 02:11:53 +00:00
dln.h
dln_find.c dln_find.c: PATH_SEP 2014-04-16 02:46:51 +00:00
dmydln.c
dmyenc.c load.c: tweak the return value 2014-12-03 06:13:58 +00:00
dmyext.c dmyenc.c: separate 2014-11-27 20:02:32 +00:00
encoding.c encoding.c: load by rb_require_internal 2014-12-03 08:13:26 +00:00
enum.c [DOC] 2014-12-12 03:15:56 +00:00
enumerator.c use 0 for reserved 2014-12-01 06:38:04 +00:00
error.c ruby.h: parent in rb_data_type_t 2014-12-24 03:16:31 +00:00
eval.c * eval.c (ruby_init): Print ruby_setup() error only in debug mode. 2015-01-02 09:49:56 +00:00
eval_error.c * eval_error.c (error_print): pos and len parameters of rb_str_substr() 2015-01-10 03:35:11 +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: drop ignored chars 2014-12-25 07:01:22 +00:00
gc.c * gc.c (wmap_final_func): fix memory size shortage when realloc wmap. 2014-12-25 08:33:41 +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
goruby.c goruby.c: suppress warning 2014-08-10 04:48:10 +00:00
GPL
hash.c * hash.c: fix docs for Hash#invert. [ruby-core:66917] [Bug #10612] 2015-01-03 15:00:31 +00:00
ia64.s
inits.c * internal.h: Include ruby.h and ruby/encoding.h to be 2014-11-15 11:49:06 +00:00
insns.def insns.def (opt_succ): remove Time#succ optimization 2014-11-13 21:55:28 +00:00
internal.h * hash.c (rb_hash_delete): return Qnil if there are no corresponding 2014-12-24 02:53:37 +00:00
io.c io.c: workaround for YARD doc 2014-12-29 01:37:29 +00:00
iseq.c compile.c: struct accessors 2014-12-17 03:20:58 +00:00
iseq.h mostly fix rb_iseq_load 2014-12-03 22:16:58 +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 load.c: reset errinfo 2014-12-03 19:20:36 +00:00
loadpath.c
localeinit.c * internal.h: Include ruby.h and ruby/encoding.h to be 2014-11-15 11:49:06 +00:00
main.c
Makefile.in * Makefile.in, common.mk: move common-srcs to Makefile.in because 2014-12-23 15:22:58 +00:00
marshal.c marshal.c: append at once 2014-12-26 06:20:55 +00:00
math.c * internal.h: Include ruby.h and ruby/encoding.h to be 2014-11-15 11:49:06 +00:00
method.h gc.c (rb_free_m_tbl): mark function as static 2014-05-22 20:17:48 +00:00
miniinit.c
NEWS * lib/drb/drb.rb: removed unused argument. Patch by @vipulnsward 2015-01-04 00:21:08 +00:00
node.c * st.c (numberof): unused. internal.h has same macro. 2014-09-21 09:22:42 +00:00
node.h * Avoid undefined behaviors found by gcc -fsanitize=undefined. 2014-10-17 08:50:01 +00:00
numeric.c * internal.h: Gather declarations in non-header files. 2014-11-18 15:13:05 +00:00
object.c object.c: [DOC] Revise documentation 2014-12-09 09:20:05 +00:00
pack.c * internal.h: Include ruby.h and ruby/encoding.h to be 2014-11-15 11:49:06 +00:00
parse.y parse.y: eliminate empty hashes 2015-01-09 02:13:03 +00:00
prelude.rb * prelude.rb: [DOC] Update Thread::exclusive docs by @stevenharman. 2014-04-17 07:31:43 +00:00
probes.d
probes_helper.h
proc.c use 0 for reserved 2014-12-01 06:38:04 +00:00
process.c process.c: missing parenthesis 2014-12-29 01:37:07 +00:00
random.c use 0 for reserved 2014-12-01 06:38:04 +00:00
range.c * internal.h: Include ruby.h and ruby/encoding.h to be 2014-11-15 11:49:06 +00:00
rational.c * rational.c: removed commented-out code. 2015-01-10 01:57:26 +00:00
re.c re.c: append excape sequence as-is 2014-12-29 09:58:48 +00:00
README.EXT README.EXT: fix typo 2014-11-27 20:38:51 +00:00
README.EXT.ja ruby.h: export keyword argument functions 2014-11-26 13:28:15 +00:00
README.ja.md * README.ja.md: add guidance of mailing list and bugs.r-l.o. 2015-01-03 15:46:05 +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 uninitialized variable 2014-12-26 06:09:11 +00:00
regint.h * Avoid undefined behaviors found by gcc -fsanitize=undefined. 2014-10-17 08:50:01 +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: do not modify shared string 2014-12-09 01:05:18 +00:00
ruby_atomic.h ruby_atomic.h (ATOMIC_OR): should return previous value 2014-10-19 17:34:02 +00:00
safe.c safe.c: preserve encoding 2014-11-25 18:43:58 +00:00
signal.c signal.c: fix received_signal 2014-12-22 05:08:34 +00:00
siphash.c UNALIGNED_WORD_ACCESS on ppc64 2014-07-23 14:50:12 +00:00
siphash.h
sparc.c
sprintf.c * internal.h: Gather declarations in non-header files. 2014-11-18 15:13:05 +00:00
st.c * internal.h: Include ruby.h and ruby/encoding.h to be 2014-11-15 11:49:06 +00:00
strftime.c
string.c * string.c: improve docs for String#<=>. [ruby-core:65399][Feature #10322] 2015-01-04 04:10:31 +00:00
struct.c iseq.c: struct accessors 2014-12-16 06:18:25 +00:00
symbol.c symbol.c: fix memory leak from global fstr hash 2015-01-01 02:18:40 +00:00
symbol.h symbol.c: symbol type predicate functions 2014-11-17 18:20:22 +00:00
thread.c thread.c: fix dynamic symbol keys 2014-12-29 02:18:20 +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 (timelocalw): Set tm_isdst field -1 if vtm->isdst is 2015-01-06 12:41:20 +00:00
timev.h configure.in, win32/Makefile.sub: PACKED_STRUCT with VC 2014-02-25 07:00:10 +00:00
transcode.c use 0 for reserved 2014-12-01 06:38:04 +00:00
transcode_data.h
util.c * internal.h: Include ruby.h and ruby/encoding.h to be 2014-11-15 11:49:06 +00:00
variable.c use 0 for reserved 2014-12-01 06:38:04 +00:00
version.c version.c: show malloc_conf 2014-06-05 05:36:28 +00:00
version.h * 2015-01-12 2015-01-11 15:58:52 +00:00
vm.c vm.c: constify 2014-12-17 03:08:20 +00:00
vm_args.c vm_args.c: fix non-symbol keys hash 2015-01-01 00:14:23 +00:00
vm_backtrace.c use 0 for reserved 2014-12-01 06:38:04 +00:00
vm_core.h vm_core.h: preserve thread ordering 2014-12-27 06:11:10 +00:00
vm_debug.h
vm_dump.c * internal.h: Include ruby.h and ruby/encoding.h to be 2014-11-15 11:49:06 +00:00
vm_eval.c vm_eval.c: fix rb_eval_string_wrap rdoc 2014-12-09 03:48:35 +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_insnhelper.c vm.c: constify 2014-12-17 03:08:20 +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: no super klass, no original method entry 2015-01-08 08:05:03 +00:00
vm_opts.h
vm_trace.c vm_trace.c: defer interrupts while postponed jobs 2014-12-13 11:41:57 +00:00
vsnprintf.c ruby.h: add mark to PRIsVALUE 2014-11-04 03:51:33 +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