development fork of ruby/ruby
Перейти к файлу
akr 80870e14a7 [DOC]
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@48782 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2014-12-12 03:15:56 +00:00
benchmark struct: avoid all O(n) behavior on access 2014-12-09 15:43:49 +00:00
bin erb: multiline anchors 2014-10-17 06:30:08 +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 * cygwin/GNUmakefile.in (uncommon.mk): link *.res.o. 2012-11-05 14:00:35 +00:00
defs id.def: move IDs for exception 2014-11-16 08:33:35 +00:00
doc * doc/syntax/refinements.rdoc: refinements are no longer experimental. 2014-12-01 01:42:38 +00:00
enc load.c: defer static linked init 2014-12-03 07:47:37 +00:00
ext * ext/socket/basicsocket.c, ext/socket/sockssocket.c: 2014-12-07 10:40:27 +00:00
gems * gems/bundled_gems: Update to 3.0.7. 2014-11-24 14:03:54 +00:00
include * class.c (class_alloc): Strat from age == 2. 2014-12-11 10:15:30 +00:00
lib * lib/prime.rb: Remove useless loop and block capture. 2014-12-10 20:38:13 +00:00
man * remove trailing spaces. 2014-12-01 01:50:02 +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 string.c: check arguments for crypt 2014-12-12 01:49:20 +00:00
tool store make output. 2014-11-27 14:42:05 +00:00
win32 * win32/win32.c (w32_spawn): `v2` is used not only for `shell` but also 2014-12-03 02:16:42 +00:00
.document * .document: Removed extra space 2013-01-16 00:36:07 +00:00
.editorconfig .editorconfig: new 2012-09-15 23:16:15 +00:00
.gdbinit .gdbinit: update for r47913 2014-11-17 21:08:23 +00:00
.gitignore tables.rb: add 2014-11-11 17:41:53 +00:00
.indent.pro
.travis.yml * .travis.yml: reverted r48199, it's unlated configuration. 2014-10-31 01:16:48 +00:00
BSDL * BSDL: update copyright notice for 2013. 2013-02-09 01:12:30 +00:00
CONTRIBUTING.md [DOC] Please see _the_ official issue tracker... [ci skip] 2014-06-13 23:42:35 +00:00
COPYING * COPYING: change Ruby's License from a dual license with GPLv2 2010-09-15 15:35:31 +00:00
COPYING.ja Change encoding from EUC-JP to UTF-8. [Feature #5128] 2011-09-04 12:22:46 +00:00
ChangeLog string.c: check arguments for crypt 2014-12-12 01:49:20 +00:00
GPL * GPL: update text of GPLv2. [ruby-core:44488] [Bug #6328] 2012-06-03 13:07:58 +00:00
KNOWNBUGS.rb * test/ruby/test_method.rb (test_unlinked_method_entry_in_method_object_bug): 2013-03-25 05:39:32 +00:00
LEGAL * LEGAL: added license infomation of ccan files. 2014-05-14 02:07:32 +00:00
Makefile.in common.mk: rebuild verconf.h for each configure 2014-12-01 08:20:45 +00:00
NEWS * NEWS: add obsolete callcc. 2014-11-27 12:26:39 +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.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
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: decoration 2014-12-02 06:59:25 +00:00
bignum.c * internal.h: Include ruby.h and ruby/encoding.h to be 2014-11-15 11:49:06 +00:00
class.c * class.c (class_alloc): Strat from age == 2. 2014-12-11 10:15:30 +00:00
common.mk common.mk: html 2014-12-02 07:06:45 +00:00
compar.c compar.c: use Module#to_s 2014-08-21 04:39:32 +00:00
compile.c compile.c (rb_iseq_build_from_ary): remove misc handling 2014-12-05 21:49:42 +00:00
complex.c * internal.h: Gather declarations in non-header files. 2014-11-18 15:13:05 +00:00
configure.in configure.in: fix --with-ruby-version [ci skip] 2014-12-05 21:14:25 +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
debug.c rb_id2str over rb_id2name 2014-11-25 18:44:22 +00:00
dir.c use 0 for reserved 2014-12-01 06:38:04 +00:00
dln.c Merges a patch form naclports. 2014-10-11 02:11:53 +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 * encoding.c (rb_enc_codepoint_len): Use UNREACHABLE to avoid "control 2012-04-13 23:45:37 +00:00
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 use 0 for reserved 2014-12-01 06:38:04 +00:00
eval.c thread.c: get rid of invalid ID symbol 2014-12-09 01:16:27 +00:00
eval_error.c * eval_error.c (error_print): respect the encoding of the message. 2014-11-28 21:11:22 +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 use 0 for reserved 2014-12-01 06:38:04 +00:00
gc.c * class.c (class_alloc): Strat from age == 2. 2014-12-11 10:15:30 +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 * ruby.c (process_options): revert r30549. 2011-01-17 12:40:30 +00:00
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
hash.c * internal.h: Gather declarations in non-header files. 2014-11-18 15:13:05 +00:00
ia64.s * removed trailing spaces. 2012-06-09 21:36:05 +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 insns.def (opt_succ): remove Time#succ optimization 2014-11-13 21:55:28 +00:00
internal.h encoding.c: load by rb_require_internal 2014-12-03 08:13:26 +00:00
io.c io.c: Fix spelling [ci skip] 2014-12-11 23:16:03 +00:00
iseq.c * class.c (class_alloc): Strat from age == 2. 2014-12-11 10:15:30 +00:00
iseq.h mostly fix rb_iseq_load 2014-12-03 22:16:58 +00:00
lex.c.blt
load.c load.c: reset errinfo 2014-12-03 19:20:36 +00:00
loadpath.c * loadpath.c (RUBY_REVISION): Defined to suppress revision.h 2013-06-17 11:56:21 +00:00
localeinit.c * internal.h: Include ruby.h and ruby/encoding.h to be 2014-11-15 11:49:06 +00:00
main.c * include/ruby/debug.h: introdudced. 2012-11-20 12:57:49 +00:00
marshal.c use 0 for reserved 2014-12-01 06:38:04 +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 ext/rbconfig/sizeof: move to an extension library 2013-11-18 14:19:16 +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: fix lex_state after tLABEL_END 2014-12-05 00:46:08 +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 use 0 for reserved 2014-12-01 06:38:04 +00:00
process.c process.c: unused variables 2014-12-11 03:02:36 +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 * internal.h: Include ruby.h and ruby/encoding.h to be 2014-11-15 11:49:06 +00:00
re.c re.c: rb_reg_region_copy 2014-12-01 21:30:58 +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 * 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 * Merge Onigmo-5.13.1. [ruby-dev:45057] [Feature #5820] 2012-02-17 07:42:23 +00:00
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 * internal.h: Gather declarations in non-header files. 2014-11-18 15:13:05 +00:00
siphash.c UNALIGNED_WORD_ACCESS on ppc64 2014-07-23 14:50:12 +00:00
siphash.h * siphash.h: check configure macros before include newer headers. 2012-11-09 15:34:31 +00:00
sparc.c * sparc.c: Use __asm__ instead of asm for gcc. 2013-04-27 10:06:20 +00:00
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 * strftime.c (rb_strftime_with_timespec): Test yday range. 2013-04-06 16:02:46 +00:00
string.c string.c: term fill 2014-12-12 02:24:51 +00:00
struct.c struct.c: use iseqval 2014-12-10 04:39:29 +00:00
symbol.c symbol.c: symbol type predicate functions 2014-11-17 18:20:22 +00:00
symbol.h symbol.c: symbol type predicate functions 2014-11-17 18:20:22 +00:00
thread.c thread.c: use the same method name 2014-12-10 00:38:43 +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 use 0 for reserved 2014-12-01 06:38:04 +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 defines.h: RUBY_SYMBOL_EXPORT_{BEGIN,END} 2013-04-05 10:29:38 +00:00
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 * 2014-12-12 2014-12-11 23:16:14 +00:00
vm.c * vm_core.h: introduce new field 2014-12-10 19:35:07 +00:00
vm_args.c fix typos 2014-11-27 13:59:01 +00:00
vm_backtrace.c use 0 for reserved 2014-12-01 06:38:04 +00:00
vm_core.h * vm_core.h: introduce new field 2014-12-10 19:35:07 +00:00
vm_debug.h defines.h: RUBY_SYMBOL_EXPORT_{BEGIN,END} 2013-04-05 10:29:38 +00:00
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_exec.h (VM_DEBUG_STACKOVERFLOW): added. 2013-12-18 05:33:50 +00:00
vm_insnhelper.c * vm_args.c: fix backtrace location for keyword related exceptions. 2014-11-27 10:15:47 +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: preserve encodings 2014-11-25 18:58:05 +00:00
vm_opts.h fix minor code comment typos 2013-04-22 19:40:10 +00:00
vm_trace.c * vm_core.h: introduce new field 2014-12-10 19:35:07 +00:00
vsnprintf.c ruby.h: add mark to PRIsVALUE 2014-11-04 03:51:33 +00:00

README.md

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