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
kazu d7167e852a fix typos
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@41465 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2013-06-20 03:53:07 +00:00
benchmark * benchmark/bm_hash_shift.rb: add benchmark for Hash#shift 2013-04-25 05:03:30 +00:00
bin irb: dead code 2013-05-02 13:11:55 +00:00
bootstraptest * bootstraptest/test_autoload.rb, bootstraptest/test_method.rb: 2013-06-13 02:01:42 +00:00
cygwin
defs id.def: predefined IDs 2013-05-02 07:54:17 +00:00
doc * NEWS: add notes for $SAFE. 2013-06-14 00:53:37 +00:00
enc * enc/trans/japanese_euc.trans, test/ruby/test_transcode.rb, 2013-06-02 14:36:41 +00:00
ext * ext/objspace/object_tracing.c: Return for ::allocation_generation 2013-06-18 13:10:25 +00:00
include * include/ruby/ruby.h (struct rb_data_type_struct), gc.c: add 2013-06-19 06:26:01 +00:00
lib * lib/cgi/util.rb (CGI.escapeHTML): performance improvement. 2013-06-19 21:11:52 +00:00
man
misc * misc/ruby-electric.el (ruby-electric-delete-backward-char): Use 2013-05-19 01:41:47 +00:00
missing fix typos. Patch by k_takata. 2013-05-19 03:10:21 +00:00
nacl fix typos. Patch by k_takata. 2013-05-19 03:10:21 +00:00
sample fix typos inspired by r40825 2013-05-19 14:50:47 +00:00
spec
symbian
template * template/verconf.h.in: unexpand exec_prefix. 2013-05-16 13:35:44 +00:00
test GC before fork to avoid spending too much time in timeout block 2013-06-20 01:49:21 +00:00
tool * tool/gcbench.rb: Summary in one line. 2013-06-19 23:15:56 +00:00
win32 win32.c: GetLastError once 2013-06-19 18:08:30 +00:00
.document
.editorconfig
.gdbinit
.gitignore Ignore tool/config.guess and tool/config.sub 2013-06-16 07:10:20 +00:00
.indent.pro
.travis.yml update config files 2013-06-14 04:40:32 +00:00
addr2line.c * addr2line.c: use more generic type: 2013-04-06 19:27:04 +00:00
addr2line.h
array.c * safe.c (rb_set_safe_level, safe_setter): raise an ArgumentError 2013-06-12 14:20:51 +00:00
bignum.c * bignum.c (BIGSIZE): New macro. 2013-06-19 23:09:05 +00:00
BSDL
ChangeLog fix typos 2013-06-20 03:53:07 +00:00
class.c * include/ruby/ruby.h (struct rb_data_type_struct), gc.c: add 2013-06-19 06:26:01 +00:00
common.mk * tool/gcbench.rb: Summary in one line. 2013-06-19 23:15:56 +00:00
compar.c * compar.c (Comparable#==): fix typo. 2013-05-06 06:40:23 +00:00
compile.c * include/ruby/ruby.h (struct rb_data_type_struct), gc.c: add 2013-06-19 06:26:01 +00:00
complex.c * gc.c: support RGENGC. [ruby-trunk - Feature #8339] 2013-05-13 18:07:47 +00:00
configure.in * configure.in: Check __int128. 2013-06-18 09:46:01 +00:00
constant.h * class.c, include/ruby/ruby.h: add write barriers for T_CLASS, 2013-06-14 09:23:54 +00:00
cont.c * cont.c: Typo in constant MAX_MACHINE_STACK_CACHE from '..MAHINE..' 2013-05-17 12:49:25 +00:00
COPYING
COPYING.ja
debug.c * safe.c (rb_set_safe_level, safe_setter): raise an ArgumentError 2013-06-12 14:20:51 +00:00
dir.c * safe.c (rb_set_safe_level, safe_setter): raise an ArgumentError 2013-06-12 14:20:51 +00:00
dln.c
dln.h dln_find.c: deprecated functions 2013-06-02 07:15:55 +00:00
dln_find.c dln_find.c: deprecated functions 2013-06-02 07:15:55 +00:00
dmydln.c
dmyencoding.c
dmyext.c
dmyloadpath.c loadpath.c: split 2013-05-15 07:56:39 +00:00
encoding.c * safe.c (rb_set_safe_level, safe_setter): raise an ArgumentError 2013-06-12 14:20:51 +00:00
enum.c * internal.h (numberof): Gathered from various files. 2013-06-07 10:01:19 +00:00
enumerator.c Update doc. 2013-05-21 13:54:31 +00:00
error.c * safe.c (rb_set_safe_level, safe_setter): raise an ArgumentError 2013-06-12 14:20:51 +00:00
eval.c eval.c: use local variable 2013-06-13 05:44:31 +00:00
eval_error.c * eval_error.c (error_print): reduce RARRAY_AREF(). 2013-06-11 06:57:04 +00:00
eval_intern.h vm_core.h: move jmpbuf between tag and prev 2013-05-18 06:49:19 +00:00
eval_jump.c
file.c * safe.c (rb_set_safe_level, safe_setter): raise an ArgumentError 2013-06-12 14:20:51 +00:00
gc.c gc.c: adjust indent 2013-06-20 00:29:13 +00:00
gc.h * gc.h (SET_MACHINE_STACK_END): Add !defined(_ILP32) to a defining 2013-05-10 15:49:56 +00:00
gem_prelude.rb
golf_prelude.rb
goruby.c
GPL
hash.c * hash.c: `st_update()' also has same issue of last fix. 2013-06-18 21:29:30 +00:00
ia64.s
inits.c
insns.def * hash.c (rb_hash_tbl_raw), internal.h: added. 2013-05-26 16:19:04 +00:00
internal.h * bignum.c (bary_2comp): Extracted from get2comp. 2013-06-16 12:59:26 +00:00
io.c * safe.c (rb_set_safe_level, safe_setter): raise an ArgumentError 2013-06-12 14:20:51 +00:00
iseq.c * include/ruby/ruby.h (struct rb_data_type_struct), gc.c: add 2013-06-19 06:26:01 +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
lex.c.blt
load.c * safe.c (rb_set_safe_level, safe_setter): raise an ArgumentError 2013-06-12 14:20:51 +00:00
loadpath.c * loadpath.c (RUBY_REVISION): Defined to suppress revision.h 2013-06-17 11:56:21 +00:00
main.c
Makefile.in * Makefile.in (after-update): non-configure platforms don't need 2013-06-14 05:10:15 +00:00
marshal.c * safe.c (rb_set_safe_level, safe_setter): raise an ArgumentError 2013-06-12 14:20:51 +00:00
math.c * internal.h (numberof): Gathered from various files. 2013-06-07 10:01:19 +00:00
method.h * class.c, include/ruby/ruby.h: add write barriers for T_CLASS, 2013-06-14 09:23:54 +00:00
NEWS * NEWS (XMLRPC::Client#http): Add. 2013-06-16 02:02:33 +00:00
node.c
node.h * gc.c: support RGENGC. [ruby-trunk - Feature #8339] 2013-05-13 18:07:47 +00:00
numeric.c * numeric.c (rb_num_to_uint): Use rb_absint_size instead of 2013-06-08 14:57:28 +00:00
object.c * class.c, include/ruby/ruby.h: add write barriers for T_CLASS, 2013-06-14 09:23:54 +00:00
pack.c * bignum.c (bary_2comp): Extracted from get2comp. 2013-06-16 12:59:26 +00:00
parse.y parse.y: clear lex_strterm 2013-06-18 07:43:47 +00:00
prelude.rb
probes.d
probes_helper.h
proc.c * include/ruby/ruby.h (struct rb_data_type_struct), gc.c: add 2013-06-19 06:26:01 +00:00
process.c * safe.c (rb_set_safe_level, safe_setter): raise an ArgumentError 2013-06-12 14:20:51 +00:00
random.c * safe.c (rb_set_safe_level, safe_setter): raise an ArgumentError 2013-06-12 14:20:51 +00:00
range.c * range.c: Fix rdoc on Range#bsearch [Bug #8242] [ruby-core:54143] 2013-06-02 03:05:26 +00:00
rational.c * rational.c (numeric_quo): move num_quo in numeric.c to numeric_quo 2013-06-07 02:50:32 +00:00
re.c * safe.c (rb_set_safe_level, safe_setter): raise an ArgumentError 2013-06-12 14:20:51 +00:00
README * README: Fix typo by Benjamin Winkler [Fixes GH-281] 2013-04-11 00:18:05 +00:00
README.EXT Add Appendix C containing a pointer to mkmf. 2013-06-12 08:48:01 +00:00
README.EXT.ja Elaborate on side-effects of mkmf functions. 2013-06-12 06:41:11 +00:00
README.ja Fix the mail address of Matz; ruby-lang.jp does not exist. 2013-06-11 08:01:38 +00:00
regcomp.c * Merge Onigmo 5.13.4 f22cf2e566712cace60d17f84d63119d7c5764ee. 2013-04-13 11:30:35 +00:00
regenc.c
regenc.h defines.h: RUBY_SYMBOL_EXPORT_{BEGIN,END} 2013-04-05 10:29:38 +00:00
regerror.c
regexec.c * Merge Onigmo 5.13.4 f22cf2e566712cace60d17f84d63119d7c5764ee. 2013-04-13 11:30:35 +00:00
regint.h * Merge Onigmo 5.13.4 f22cf2e566712cace60d17f84d63119d7c5764ee. 2013-04-13 11:30:35 +00:00
regparse.c * Merge Onigmo 5.13.4 f22cf2e566712cace60d17f84d63119d7c5764ee. 2013-04-13 11:30:35 +00:00
regparse.h defines.h: RUBY_SYMBOL_EXPORT_{BEGIN,END} 2013-04-05 10:29:38 +00:00
regsyntax.c
ruby.c * internal.h (numberof): Gathered from various files. 2013-06-07 10:01:19 +00:00
ruby_atomic.h * configure.in (AC_CHECK_HEADERS): atomic.h for Solaris atomic_ops. 2013-04-06 15:00:44 +00:00
safe.c ruby.h: safe_level check 2013-06-13 05:51:14 +00:00
signal.c * signal.c: need to include unistd.h for write(2). 2013-05-14 15:44:14 +00:00
siphash.c * regint.h: fix typo: _M_AMD86 -> _M_AMD64. 2013-04-10 21:16:44 +00:00
siphash.h
sparc.c * sparc.c: Use __asm__ instead of asm for gcc. 2013-04-27 10:06:20 +00:00
sprintf.c * internal.h (INTEGER_PACK_2COMP): Defined. 2013-06-16 09:53:45 +00:00
st.c * st.c (st_shift): remove unused variable. 2013-04-25 05:25:53 +00:00
strftime.c * strftime.c (rb_strftime_with_timespec): Test yday range. 2013-04-06 16:02:46 +00:00
string.c * include/ruby/ruby.h, vm_eval.c (rb_funcall_with_block): 2013-06-17 12:47:26 +00:00
struct.c * struct.c: Improve documentation: replace "instance variable" with 2013-06-11 22:17:02 +00:00
thread.c * safe.c (rb_set_safe_level, safe_setter): raise an ArgumentError 2013-06-12 14:20:51 +00:00
thread_pthread.c * internal.h (numberof): Gathered from various files. 2013-06-07 10:01:19 +00:00
thread_pthread.h
thread_win32.c timev.h: move time_t stuffs 2013-03-30 21:08:36 +00:00
thread_win32.h
time.c Unused variable removed. 2013-06-11 16:37:37 +00:00
timev.h timev.h: move time_t stuffs 2013-03-30 21:08:36 +00:00
transcode.c * safe.c (rb_set_safe_level, safe_setter): raise an ArgumentError 2013-06-12 14:20:51 +00:00
transcode_data.h defines.h: RUBY_SYMBOL_EXPORT_{BEGIN,END} 2013-04-05 10:29:38 +00:00
util.c * util.c (ruby_hdtoa): revert r29729. 2013-04-22 02:59:09 +00:00
variable.c * variable.c (rb_const_set): fix WB miss. 2013-06-18 19:50:44 +00:00
version.c loadpath.c: split 2013-05-15 07:56:39 +00:00
version.h * 2013-06-20 2013-06-19 15:06:31 +00:00
vm.c * include/ruby/ruby.h (struct rb_data_type_struct), gc.c: add 2013-06-19 06:26:01 +00:00
vm_backtrace.c * vm_backtrace.c: Update rdoc for Backtrace#label with @_ko1 2013-06-17 05:31:28 +00:00
vm_core.h * include/ruby/ruby.h (struct rb_data_type_struct), gc.c: add 2013-06-19 06:26:01 +00:00
vm_debug.h defines.h: RUBY_SYMBOL_EXPORT_{BEGIN,END} 2013-04-05 10:29:38 +00:00
vm_dump.c * vm_dump.c (rb_vm_bugreport): show name of class and module. 2013-05-22 08:03:53 +00:00
vm_eval.c * include/ruby/ruby.h, vm_eval.c (rb_funcall_with_block): 2013-06-17 12:47:26 +00:00
vm_exec.c
vm_exec.h fix minor code comment typos 2013-04-22 19:40:10 +00:00
vm_insnhelper.c * vm_insnhelper.c (vm_call_method): ensure methods of type 2013-06-18 14:01:32 +00:00
vm_insnhelper.h
vm_method.c * class.c, include/ruby/ruby.h: add write barriers for T_CLASS, 2013-06-14 09:23:54 +00:00
vm_opts.h fix minor code comment typos 2013-04-22 19:40:10 +00:00
vm_trace.c * safe.c (rb_set_safe_level, safe_setter): raise an ArgumentError 2013-06-12 14:20:51 +00:00
vsnprintf.c

= 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 YourFirstName YourFamilyName
e.g.
        subscribe Joseph Smith

in the mail body (not subject) to the address <mailto:ruby-talk-ctl@ruby-lang.org>.


== How to compile and install

This is what you need to do to compile and install Ruby:

0.   If you want to use Microsoft Visual C++ to compile ruby,
     read win32/README.win32 instead of this document.

1.   If +./configure+ does not exist or is older than configure.in,
     run autoconf to (re)generate configure.

2.   Run +./configure+, which will generate config.h and Makefile.

     Some C compiler flags may be added by default depending on your
     environment.  Specify <tt>optflags=..</tt> and <tt>warnflags=..</tt> as
     necessary to override them.

3.   Edit +defines.h+ if you need. Usually this step will not be needed.

4.   Remove comment mark(<tt>#</tt>) 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 "<tt>#option nodynamic</tt>" in
     +ext/Setup+.

     Usually this step will not be needed.

5.   Run +make+.

6.   Optionally, run '<tt>make check</tt>' to check whether the compiled Ruby
     interpreter works well. If you see the message "<tt>check succeeded</tt>",
     your ruby works as it should (hopefully).

7.   Run '<tt>make install</tt>'

     This command will create following directories and install files
     onto them.

     * <tt>${DESTDIR}${prefix}/bin</tt>
     * <tt>${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}</tt>
     * <tt>${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}</tt>
     * <tt>${DESTDIR}${prefix}/lib</tt>
     * <tt>${DESTDIR}${prefix}/lib/ruby</tt>
     * <tt>${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}</tt>
     * <tt>${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}</tt>
     * <tt>${DESTDIR}${prefix}/lib/ruby/site_ruby</tt>
     * <tt>${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}</tt>
     * <tt>${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}</tt>
     * <tt>${DESTDIR}${prefix}/lib/ruby/vendor_ruby</tt>
     * <tt>${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}</tt>
     * <tt>${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}</tt>
     * <tt>${DESTDIR}${prefix}/lib/ruby/gems/${MAJOR}.${MINOR}.${TEENY}</tt>
     * <tt>${DESTDIR}${prefix}/share/man/man1</tt>
     * <tt>${DESTDIR}${prefix}/share/ri/${MAJOR}.${MINOR}.${TEENY}/system</tt>

     If Ruby's API version is '_x.y.z_', the <tt>${MAJOR}</tt> is '_x_', the
     <tt>${MINOR}</tt> is '_y_', and the <tt>${TEENY}</tt> 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
'<tt>make distclean-ext</tt>' 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>

--
Local variables:
mode: rdoc
end: