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
ngoto f70a7cd20f * configure.in (AC_CHECK_HEADERS): atomic.h for Solaris atomic_ops.
* ruby_atomic.h: Skip using Solaris10 atomic_ops on Solaris 9 or earlier if atomic.h is not available. [ruby-dev:47229] [Bug #8228]


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@40163 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2013-04-06 15:00:44 +00:00
benchmark
bin
bootstraptest test: tty option 2013-01-15 00:59:19 +00:00
cygwin
defs gmake.mk: order test-all and test-knownbug 2013-03-27 03:42:19 +00:00
doc * remove trailing spaces. 2013-04-01 15:10:33 +00:00
enc mswin: static-linked-ext 2013-03-02 15:04:23 +00:00
ext * ext/socket/socket.c (rsock_sys_fail_raddrinfo): Renamed from 2013-04-06 11:21:05 +00:00
include fix a typo. 2013-04-05 11:57:59 +00:00
lib * lib/resolv.rb: Support LOC resources. 2013-04-06 14:52:48 +00:00
man * man/rake.1, man/ruby.1: Use the Pa macro to make URLs stand out. 2013-03-08 11:16:00 +00:00
misc misc/ruby-electric.el: Avoid electric insertion in some cases. 2013-02-23 03:55:39 +00:00
missing * configure.in: check for the whether crt_externs.h is present when compiling 2012-12-28 14:23:25 +00:00
nacl Fix failures on btest for NativeClient. 2013-01-03 15:39:15 +00:00
sample * lib/drb/drb.rb: Improved documentation by adding or hiding methods. 2013-01-25 03:25:39 +00:00
spec
symbian
template defs/gmake.mk: serialize test targets. 2013-03-06 11:59:23 +00:00
test * ext/socket/rubysocket.h (SockAddrStringValueWithAddrinfo): New macro. 2013-04-06 05:50:42 +00:00
tool win32/configure.bat: option arguments 2013-03-31 06:40:37 +00:00
win32 win32.c: pass through unknown sequence 2013-04-03 08:11:24 +00:00
.document * .document: Removed extra space 2013-01-16 00:36:07 +00:00
.editorconfig
.gdbinit .gdbinit: initialize color sequences 2013-03-07 04:38:50 +00:00
.gitignore
.indent.pro
.travis.yml
addr2line.c * addr2line.c: quad_t and u_quad_t is not available on Solaris. 2013-04-06 14:45:06 +00:00
addr2line.h
array.c reduce overhead of TYPE 2013-04-04 08:23:10 +00:00
bignum.c bignum.c: hide intermediate Bignums 2013-04-03 07:35:35 +00:00
BSDL * BSDL: update copyright notice for 2013. 2013-02-09 01:12:30 +00:00
ChangeLog * configure.in (AC_CHECK_HEADERS): atomic.h for Solaris atomic_ops. 2013-04-06 15:00:44 +00:00
class.c class.c: suppress wrong warning 2013-03-30 21:27:27 +00:00
common.mk timev.h: move time_t stuffs 2013-03-30 21:08:36 +00:00
compar.c compar.c: inversed comarison without infinite recursion 2013-02-17 11:55:50 +00:00
compile.c compile.c: defined? with empty expression 2013-04-05 10:40:03 +00:00
complex.c * complex.c: edited rdoc. 2013-03-10 08:01:32 +00:00
configure.in * configure.in (AC_CHECK_HEADERS): atomic.h for Solaris atomic_ops. 2013-04-06 15:00:44 +00:00
constant.h
cont.c defines.h: RUBY_SYMBOL_EXPORT_{BEGIN,END} 2013-04-05 10:29:38 +00:00
COPYING
COPYING.ja
debug.c
dir.c compose HFS file names 2013-03-19 08:06:53 +00:00
dln.c
dln.h defines.h: RUBY_SYMBOL_EXPORT_{BEGIN,END} 2013-04-05 10:29:38 +00:00
dln_find.c
dmydln.c
dmyencoding.c
dmyext.c
dmyversion.c
encoding.c * encoding.c: Typo in Encoding overview by Tom Wardrop [GH fixes #255] 2013-03-04 01:24:40 +00:00
enum.c enum.c: avoid inadvertent symbol creation 2013-04-04 06:46:53 +00:00
enumerator.c * enumerator.c (enumerator_with_index): try to convert given offset to 2013-03-11 09:47:15 +00:00
error.c error.c: rb_sys_fail_path_in 2013-03-15 11:19:56 +00:00
eval.c reduce overhead of TYPE 2013-04-04 08:23:10 +00:00
eval_error.c
eval_intern.h * configure.in: check for the whether crt_externs.h is present when compiling 2012-12-28 14:23:25 +00:00
eval_jump.c
file.c documentation by @phiggins [GH fixes #263] 2013-03-31 02:21:07 +00:00
gc.c gc.c: _aligned_malloc 2013-03-30 21:08:30 +00:00
gc.h defines.h: RUBY_SYMBOL_EXPORT_{BEGIN,END} 2013-04-05 10:29:38 +00:00
gem_prelude.rb
golf_prelude.rb
goruby.c
GPL
hash.c * array.c: Fix rdoc for flatten! 2013-02-23 20:17:20 +00:00
ia64.s
inits.c
insns.def * insns.def: fix condition. 2013-03-12 08:02:17 +00:00
internal.h defines.h: RUBY_SYMBOL_EXPORT_{BEGIN,END} 2013-04-05 10:29:38 +00:00
io.c * io.c (rb_io_seek_m): Accept :CUR, :END, :SET as "whence" argument. 2013-04-03 12:25:09 +00:00
iseq.c * iseq.c (iseq_load): get rid of SEGV. 2013-03-26 06:24:26 +00:00
iseq.h defines.h: RUBY_SYMBOL_EXPORT_{BEGIN,END} 2013-04-05 10:29:38 +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
lex.c.blt
load.c * load.c (features_index_add): use rb_str_subseq() to specify C string 2013-04-05 15:30:52 +00:00
main.c
Makefile.in compiler version 2013-03-22 07:57:09 +00:00
marshal.c * marshal.c (marshal_dump, marshal_load): workaround for segv on 2013-03-21 13:50:20 +00:00
math.c
method.h vm_method.c: show respond_to location 2013-02-06 04:35:23 +00:00
NEWS * lib/resolv.rb: Support LOC resources. 2013-04-06 14:52:48 +00:00
node.c
node.h defines.h: RUBY_SYMBOL_EXPORT_{BEGIN,END} 2013-04-05 10:29:38 +00:00
numeric.c * numeric.c (rb_num2ulong_internal): Don't cast a negative double value 2013-04-01 12:14:30 +00:00
object.c object.c: avoid inadvertent symbol creation 2013-04-04 21:36:38 +00:00
pack.c pack.c: fix definition order 2013-04-06 00:54:23 +00:00
parse.y parse.y: "nil" for defined? with empty expression 2013-04-05 17:30:42 +00:00
prelude.rb
probes.d gen_dummy_probes.rb 2013-03-11 05:25:06 +00:00
probes_helper.h
proc.c proc.c: consider noex in define_method 2013-03-31 08:18:09 +00:00
process.c * process.c: Describe the behavior which Ruby invokes a commandline 2013-04-03 11:55:18 +00:00
random.c * configure.in: check struct timeval exist or not. 2013-03-16 05:06:47 +00:00
range.c prefix global symbols 2013-03-06 06:30:03 +00:00
rational.c * rational.c: fix dangling if, else-if and else. 2013-03-12 08:00:16 +00:00
re.c * re.c (rb_reg_to_s): suppress duplicated charclass warning. 2013-04-02 08:44:16 +00:00
README * README: Fix typo, patch by zzak 2013-02-06 05:25:40 +00:00
README.EXT
README.EXT.ja
README.ja
regcomp.c * Merge Onigmo 0fe387da2fee089254f6b04990541c731a26757f 2013-03-01 16:36:37 +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 d4bad41e16e3eccd97ccce6f1f96712e557c4518. 2013-03-11 03:46:55 +00:00
regint.h defines.h: RUBY_SYMBOL_EXPORT_{BEGIN,END} 2013-04-05 10:29:38 +00:00
regparse.c * Merge Onigmo 0fe387da2fee089254f6b04990541c731a26757f 2013-03-01 16:36:37 +00:00
regparse.h defines.h: RUBY_SYMBOL_EXPORT_{BEGIN,END} 2013-04-05 10:29:38 +00:00
regsyntax.c
ruby.c * ruby.c (is_option_with_optarg): macro for optional argument option. 2013-02-27 08:08:10 +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
signal.c envutil.rb: signal in Process::Status 2013-03-25 05:39:29 +00:00
siphash.c
siphash.h
sparc.c
sprintf.c
st.c
strftime.c
string.c reduce overhead of TYPE 2013-04-04 08:23:10 +00:00
struct.c struct.c: avoid inadvertent symbol creation 2013-04-04 07:55:11 +00:00
thread.c thread.c: no allocate before deleting 2013-04-05 15:21:02 +00:00
thread_pthread.c * thread_pthread.c: Fixes wrong scopes of #if USE_SLEEPY_TIMER_THREAD 2013-04-04 08:01:27 +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 * time.c (time_strftime): Describe %L and %N truncates digits under 2013-04-04 13:37:22 +00:00
timev.h timev.h: move time_t stuffs 2013-03-30 21:08:36 +00:00
transcode.c use INT2FIX(0) instead of INT2NUM(0). 2013-03-05 16:31:19 +00:00
transcode_data.h defines.h: RUBY_SYMBOL_EXPORT_{BEGIN,END} 2013-04-05 10:29:38 +00:00
util.c
variable.c * variable.c (rb_mod_remove_const): fix segv caused by r38558. 2012-12-27 16:45:36 +00:00
version.c version.c: move ruby_exec_prefix 2013-02-18 01:11:58 +00:00
version.h * 2013-04-06 2013-04-05 15:21:07 +00:00
vm.c load.c: loaded_features_index st_table 2013-03-22 08:38:51 +00:00
vm_backtrace.c defines.h: RUBY_SYMBOL_EXPORT_{BEGIN,END} 2013-04-05 10:29:38 +00:00
vm_core.h defines.h: RUBY_SYMBOL_EXPORT_{BEGIN,END} 2013-04-05 10:29:38 +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_print_backtrace): separate to ease showing C backtrace. 2013-04-02 07:02:54 +00:00
vm_eval.c vm_eval.c: preserve passed_block 2013-03-23 08:39:55 +00:00
vm_exec.c * vm_exec.c: Correct predefined macro name. This typo is introduced by 2013-03-18 01:45:12 +00:00
vm_exec.h * vm_exec.h (END_INSN): revert r39517 because the segv seems fixed by 2013-03-18 02:06:44 +00:00
vm_insnhelper.c vm_insnhelper.c: check required kwarg with resthash 2013-03-21 19:51:19 +00:00
vm_insnhelper.h
vm_method.c * vm_method.c (rb_sweep_method_entry): simplify code to unlink. 2013-03-24 10:43:37 +00:00
vm_opts.h
vm_trace.c prefix global symbols 2013-03-06 06:30:03 +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 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 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: