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 53a619de6c fake.rb.in: block comment
* template/fake.rb.in: move shell code inside a block comment.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@52709 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2015-11-22 06:42:14 +00:00
benchmark io.c: avoid kwarg parsing in C API 2015-11-12 02:00:41 +00:00
bin * bin/erb: $SAFE=3 is obsolete. 2015-06-18 14:53:26 +00:00
bootstraptest * bootstraptest/test_fork.rb ([ruby-dev:37934]): :NPROC (RLIMIT_NPROC) 2015-11-10 08:50:06 +00:00
ccan ccan/list/list.h: suppress unused argument warnings 2015-09-06 07:10:54 +00:00
coverage
cygwin win32.c: fake lchown 2015-08-26 05:21:41 +00:00
defs * compile.c (iseq_compile_each): add debug information to NODE_STR 2015-11-20 23:49:31 +00:00
doc * doc/syntax/refinements.rdoc: update documentation to reflect 2015-11-18 01:08:19 +00:00
enc enc/unicode/casefold.h, name2ctype.h: Change Unicode Version for 2015-11-17 06:30:39 +00:00
ext * ext/digest/sha1/extconf.rb: OpenSSL's struct name for SHA1 is 2015-11-21 05:01:55 +00:00
gems * gems/bundled_gems: update to power_assert 0.2.6. 2015-11-09 15:27:16 +00:00
include * time.c (rb_timespec_now): added. 2015-11-10 02:59:47 +00:00
lib * lib/logger.rb: expose logger mutex 2015-11-20 14:16:56 +00:00
man ruby.1: --dump [ci skip] 2015-11-15 02:04:37 +00:00
misc parse.y: ANDDOT fluent interface 2015-11-12 05:17:06 +00:00
missing * ChangeLog: Good-bye OS/2. 2015-10-18 01:18:34 +00:00
nacl Fix PNaCl configure/link errors. 2014-10-22 12:19:21 +00:00
sample * sample/exyacc.rb: Fix some typos. 2015-06-12 09:20:44 +00:00
spec * spec/default.mspec: use default configuration file name. 2015-02-25 13:25:11 +00:00
template fake.rb.in: block comment 2015-11-22 06:42:14 +00:00
test * test/socket/test_socket.rb (test/socket/test_socket.rb): skip the test when Socket::SO_TIMESTAMP is not defined. 2015-11-21 16:19:06 +00:00
tool enc-unicode.rb: --header 2015-11-20 04:03:10 +00:00
win32 * win32/win32.c (finish_overlapped_socket): return value of this 2015-11-19 05:16:13 +00:00
.document * .document: removed needless entries. 2015-03-25 01:39:11 +00:00
.editorconfig
.gdbinit rbi 2015-11-10 03:36:08 +00:00
.gitattributes add .gitattributes 2015-11-19 22:09:47 +00:00
.gitignore * test/runner.rb: use official repository for coverage tool. 2015-11-09 08:38:20 +00:00
.indent.pro
.travis.yml * .travis.yml: retry. 2015-09-09 02:20:42 +00:00
aclocal.m4 Makefile.in: tty at reconfig 2015-10-21 07:16:33 +00:00
addr2line.c
addr2line.h
array.c * array.c: clarify docs for take_while/drop_while samples. 2015-11-20 03:53:25 +00:00
bignum.c preserve encodings in error messages 2015-09-28 02:40:46 +00:00
BSDL
ChangeLog * configure.in: Add -D_XOPEN_SOURCE=500 (or 600 or 700) on Solaris 2015-11-21 16:37:12 +00:00
class.c * class.c: fix documentation for rb_define_class{_id}_under. 2015-11-04 06:46:05 +00:00
common.mk * ext/extmk.rb (--extflags): new option to pass EXTLDFLAGS to children, 2015-11-18 15:55:39 +00:00
compar.c compar.c: variable name [ci skip] 2015-02-21 07:18:45 +00:00
compile.c compile.c: free labels table 2015-11-22 06:32:38 +00:00
complex.c preserve encodings in error messages 2015-09-28 02:40:46 +00:00
configure.in * configure.in: Add -D_XOPEN_SOURCE=500 (or 600 or 700) on Solaris 2015-11-21 16:37:12 +00:00
constant.h variable.c: Module#deprecate_constant 2015-07-30 04:20:00 +00:00
cont.c cont.c: append to continuations doc [ci skip] 2015-09-20 01:07:40 +00:00
CONTRIBUTING.md
COPYING
COPYING.ja
debug.c ruby.h: add prefix 2015-09-13 02:03:31 +00:00
dir.c * dir.c (dir_fileno, dirfd): support of Dir#fileno on Solaris 10. 2015-11-06 17:07:08 +00:00
dln.c * dln.c: remove defined(__WATCOMC__). 2015-10-18 02:23:18 +00:00
dln.h
dln_find.c * ChangeLog: Good-bye OS/2. 2015-10-18 01:18:34 +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
encindex.h revert r52336 (commit miss) 2015-10-29 05:30:50 +00:00
encoding.c ENC_ASSERT 2015-10-29 14:31:48 +00:00
enum.c add a comment. 2015-10-04 14:42:52 +00:00
enumerator.c preserve encodings in error messages 2015-09-28 02:40:46 +00:00
error.c * compile.c (iseq_compile_each): add debug information to NODE_STR 2015-11-20 23:49:31 +00:00
eval.c * vm.c (rb_vm_cref_replace_with_duplicated_cref): added. 2015-11-20 00:17:25 +00:00
eval_error.c eval_error.c: Fix a format of NameError#message 2015-10-31 01:22:51 +00:00
eval_intern.h * vm.c (rb_vm_cref_replace_with_duplicated_cref): added. 2015-11-20 00:17:25 +00:00
eval_jump.c eval.c: use the given thread 2015-02-24 02:05:28 +00:00
file.c * file.c: Add O_TMPFILE. 2015-11-08 06:26:44 +00:00
gc.c * gc.c (gc_start): force to invoke GC by GC.start 2015-11-19 12:57:20 +00:00
gc.h * gc.h, gc.c: introduce new debug function rb_obj_info_dump(VALUE obj) 2015-10-06 16:22:54 +00:00
gem_prelude.rb * ruby.c (usage, enable_option, disable_option, process_options): new 2015-09-09 07:57:31 +00:00
golf_prelude.rb
goruby.c
GPL
hash.c update rdoc of dig methods [ci skip] 2015-11-17 02:25:28 +00:00
ia64.s
id_table.c id_table: const correctness for _size and _memsize 2015-11-02 22:18:32 +00:00
id_table.h id_table: const correctness for _size and _memsize 2015-11-02 22:18:32 +00:00
inits.c * internal.h: Include ruby.h and ruby/encoding.h to be 2014-11-15 11:49:06 +00:00
insns.def * compile.c (iseq_compile_each): add debug information to NODE_STR 2015-11-20 23:49:31 +00:00
internal.h struct.c: dig 2015-11-16 09:21:56 +00:00
io.c io.c: avoid kwarg parsing in C API 2015-11-12 02:00:41 +00:00
iseq.c iseq.c (iseq_memsize): account for rb_call_cache entries 2015-11-01 02:13:54 +00:00
iseq.h * ruby.c: introduce --enable-frozen-string-literal-debug option. 2015-10-23 19:02:55 +00:00
KNOWNBUGS.rb
LEGAL LEGAL: adjust style 2015-08-17 08:12:23 +00:00
lex.c.blt keywords: make name singed 2015-11-02 23:08:26 +00:00
load.c internal.h: RUBY_DTRACE_HOOK 2015-10-31 01:02:29 +00:00
loadpath.c
localeinit.c localeinit.c: encindex.h 2015-09-15 05:57:30 +00:00
main.c
Makefile.in * test/runner.rb: use official repository for coverage tool. 2015-11-09 08:38:20 +00:00
marshal.c marshal.c: reduce arity checks 2015-09-25 13:14:16 +00:00
math.c object.c: rb_num_to_dbl 2015-08-13 05:36:33 +00:00
method.h * method.h: introduce the folliwing field and macros. 2015-11-18 08:15:51 +00:00
miniinit.c encoding.c: find encoding index 2015-08-24 07:01:22 +00:00
NEWS add to NEWS about Queue#close 2015-11-21 00:46:53 +00:00
node.c Safe navigation operator 2015-10-22 06:30:12 +00:00
node.h additional fix of comment line 2015-11-13 20:05:37 +00:00
numeric.c * numeric.c: Good-by Borland-C. 2015-10-18 02:10:34 +00:00
object.c struct.c: dig 2015-11-16 09:21:56 +00:00
pack.c * pack.c (pack_unpack, AVOID_CC_BUG): Very ugly workaround for 2015-11-13 17:06:43 +00:00
parse.y parse.y: optimize condition for unless 2015-11-13 01:36:42 +00:00
prelude.rb prelude.rb: deprecate Thread.exclusive 2015-11-13 04:05:43 +00:00
probes.d change lingering dtrace probe documentation from function- to method- 2015-05-30 02:04:26 +00:00
probes_helper.h vm.c: ruby_th_dtrace_setup 2015-10-29 05:32:19 +00:00
proc.c * proc.c: Add call-seq of Method#super_method 2015-11-16 07:00:56 +00:00
process.c process.c: fix rdoc of Process.getsid [ci skip] 2015-11-04 02:38:25 +00:00
random.c random.c: comment [ci skip] 2015-10-18 05:51:44 +00:00
range.c NameError#receiver of uninitialized constant 2015-10-28 06:24:12 +00:00
rational.c rational.c: preserve encoding in exception 2015-09-11 20:36:18 +00:00
re.c re.c: indent [ci skip] 2015-10-07 08:26:56 +00:00
README.EXT README.EXT: add redirect [ruby-core:68631] 2015-03-25 21:43:58 +00:00
README.EXT.ja README.EXT.ja: add redirect [ruby-core:68631] 2015-03-30 13:08:16 +00:00
README.ja.md README.ja.md: fix markup miss. [ci skip] 2015-06-10 13:03:07 +00:00
README.md * README.md: improve markdown rendering for readable. 2015-09-12 07:07:17 +00:00
regcomp.c
regenc.c oniguruma.h: constify 2015-08-27 19:49:45 +00:00
regenc.h oniguruma.h: constify 2015-08-27 19:49:45 +00:00
regerror.c
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.h
regsyntax.c
ruby.c ruby.c: --debug=frozen-string-literal option 2015-11-21 09:57:31 +00:00
ruby_atomic.h ruby_atomic.h: fix typo 2015-09-07 06:55:01 +00:00
safe.c * safe.c: removed needless doc related $SAFE=2 2015-06-18 14:47:37 +00:00
signal.c * signal.c: should also clear ruby_disable_gc. 2015-11-19 06:54:35 +00:00
siphash.c
siphash.h
sparc.c
sprintf.c sprintf.c: nil value is valid 2015-11-11 09:30:31 +00:00
st.c st.c: constify st_table* in private functions 2015-07-29 23:55:23 +00:00
strftime.c
string.c string.c: use predefined IDs for minor bloat reduction 2015-11-07 03:18:58 +00:00
struct.c update rdoc of dig methods [ci skip] 2015-11-17 02:25:28 +00:00
symbol.c symbol.c: not freeze the receiver 2015-11-20 19:34:19 +00:00
symbol.h * ext/objspace/objspace.c: add a new method ObjectSpace.count_symbols. 2015-08-21 11:30:24 +00:00
thread.c thread.c (rb_cThreadShield): make static 2015-11-07 02:40:33 +00:00
thread_pthread.c * thread_pthread.c: fix compile erros when 2015-10-25 16:07:25 +00:00
thread_pthread.h
thread_sync.c * thread_sync.c: reduce the specification of Queue#close. 2015-11-21 00:32:09 +00:00
thread_win32.c improve handling of timer thread shutdown 2015-08-14 09:44:10 +00:00
thread_win32.h
time.c * time.c (rb_time_timespec_new): swap utc and localtime 2015-11-10 05:36:47 +00:00
timev.h
transcode.c * transcode.c: fix a typo 2015-11-11 05:14:36 +00:00
transcode_data.h transcode_data.h: missing cast 2015-08-08 00:33:11 +00:00
util.c util.c: BSD qsort_r 2015-09-15 03:44:34 +00:00
variable.c variable.c (rb_autoload_load): allow recursive calls 2015-11-09 21:18:42 +00:00
version.c fake.rb.in: scan version.c 2015-06-11 08:07:49 +00:00
version.h * 2015-11-22 2015-11-21 16:19:21 +00:00
vm.c * vm.c (rb_vm_cref_replace_with_duplicated_cref): added. 2015-11-20 00:17:25 +00:00
vm_args.c vm_args.c: symbol proc 2015-10-16 03:21:10 +00:00
vm_backtrace.c * make rb_iseq_t T_IMEMO object (type is imemo_iseq). 2015-07-21 22:52:59 +00:00
vm_core.h * insns.def (getinlinecache/setinlinecache): compare ic->ic_cref and 2015-10-29 22:43:45 +00:00
vm_debug.h
vm_dump.c * vm_dump.c (rb_print_backtrace): our addr2line doesn't work on sparc. 2015-10-27 07:13:39 +00:00
vm_eval.c * vm.c (rb_vm_cref_replace_with_duplicated_cref): added. 2015-11-20 00:17:25 +00:00
vm_exec.c * vm_core.h: constify rb_iseq_constant_body::iseq_encoded and 2015-07-23 09:34:31 +00:00
vm_exec.h
vm_insnhelper.c * vm.c (rb_vm_cref_replace_with_duplicated_cref): added. 2015-11-20 00:17:25 +00:00
vm_insnhelper.h * refactoring CREF related code. 2015-11-13 20:02:19 +00:00
vm_method.c * vm_method.c (rb_class_clear_method_cache): should clear all 2015-11-18 13:59:57 +00:00
vm_opts.h * iseq.c (make_compile_option_value): include frozen_string_literal* 2015-10-23 19:13:51 +00:00
vm_trace.c * vm_trace.c (exec_hooks_precheck): check need_clean everytime 2015-11-07 23:10:55 +00:00
vsnprintf.c vsnprintf.c: constify 2015-09-28 16:11:41 +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 (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, 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 on 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 to 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}/${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 (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. 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.

mailto:matz@ruby-lang.org