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
xibbar 7a8a7864b1 * lib/cgi/cookie.rb (inspect): add inspect for debug.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@41044 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2013-06-03 02:38:32 +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
cygwin
defs id.def: predefined IDs 2013-05-02 07:54:17 +00:00
doc * remove trailing spaces. 2013-05-19 03:11:09 +00:00
enc * enc/trans/japanese_euc.trans, test/ruby/test_transcode.rb, 2013-06-02 14:36:41 +00:00
ext * ext/socket/option.c: rename functions introduced in r41009 2013-06-02 14:24:34 +00:00
include error.c: better names for rb_exc_new family 2013-06-01 02:16:25 +00:00
lib * lib/cgi/cookie.rb (inspect): add inspect for debug. 2013-06-03 02:38:32 +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 * vm_insnhelper.c (vm_yield_setup_block_args): partially revert r41019. 2013-06-02 18:44:33 +00:00
tool * enc/trans/japanese_euc.trans, test/ruby/test_transcode.rb, 2013-06-02 14:36:41 +00:00
win32 win32.c: check error of SetFilePointer 2013-05-22 06:19:03 +00:00
.document
.editorconfig
.gdbinit
.gitignore
.indent.pro
.travis.yml Disable clang on travis because it causes many false negative 2013-05-24 03:59:17 +00:00
addr2line.c * addr2line.c: use more generic type: 2013-04-06 19:27:04 +00:00
addr2line.h
array.c array.c: new names of rb_ary_new family 2013-05-31 08:04:56 +00:00
bignum.c * bignum.c: Use BDIGIT type for hbase. 2013-05-31 22:32:55 +00:00
BSDL
ChangeLog * configure.in: removes AC_CHECK_FUNCS(readdir_r). readdir_r() 2013-06-02 22:38:11 +00:00
class.c * include/ruby/ruby.h: constify RBasic::klass and add 2013-05-13 10:49:11 +00:00
common.mk * include/ruby/debug.h, vm_trace.c: add rb_postponed_job API. 2013-05-26 21:30:44 +00:00
compar.c * compar.c (Comparable#==): fix typo. 2013-05-06 06:40:23 +00:00
compile.c compile.c: not simple if keyword args 2013-06-01 08:25:05 +00:00
complex.c * gc.c: support RGENGC. [ruby-trunk - Feature #8339] 2013-05-13 18:07:47 +00:00
configure.in * configure.in: removes AC_CHECK_FUNCS(readdir_r). readdir_r() 2013-06-02 22:38:11 +00:00
constant.h
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 * gc.c: support RGENGC. [ruby-trunk - Feature #8339] 2013-05-13 18:07:47 +00:00
dir.c * configure.in: removes AC_CHECK_FUNCS(readdir_r). readdir_r() 2013-06-02 22:38:11 +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 * encoding.c: document fix, change default script encoding. 2013-05-19 14:15:42 +00:00
enum.c * include/ruby/ruby.h: constify RBasic::klass and add 2013-05-13 10:49:11 +00:00
enumerator.c Update doc. 2013-05-21 13:54:31 +00:00
error.c fill rdocs 2013-06-02 03:12:04 +00:00
eval.c eval.c: rb_frame_callee returns current name 2013-05-25 02:24:33 +00:00
eval_error.c call rb_frame_callee() only once 2013-05-24 22:03:41 +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 fill rdocs 2013-06-02 03:12:04 +00:00
gc.c * gc.c (gc_profile_enable): rest_sweep() to finish last GC. 2013-05-29 15:10:28 +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 fill rdocs 2013-06-02 03:12:04 +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 * ext/objspace/objspace.c: support ObjectSpace.trace_object_allocations. 2013-05-27 10:01:45 +00:00
io.c fill rdocs 2013-06-02 03:12:04 +00:00
iseq.c * iseq.c (prepare_iseq_build): remove additional line braek. 2013-05-13 11:11:53 +00:00
iseq.h iseq: reduce array allocations for simple sequences 2013-04-17 11:20:23 +00:00
KNOWNBUGS.rb
LEGAL
lex.c.blt
load.c load.c: fix invalid read 2013-05-23 08:35:34 +00:00
loadpath.c configure.in: shvar_to_cpp in ruby 2013-05-15 07:58:28 +00:00
main.c
Makefile.in Makefile.in: loadpath from loadpath.c 2013-05-16 07:54:04 +00:00
marshal.c fill rdocs 2013-06-02 03:12:04 +00:00
math.c math.c: ASCII minus 2013-06-02 05:59:40 +00:00
method.h vm_method.c: rb_method_entry_at 2013-05-13 05:51:14 +00:00
NEWS Add a NEWS 2013-05-30 07:59:21 +00:00
node.c
node.h * gc.c: support RGENGC. [ruby-trunk - Feature #8339] 2013-05-13 18:07:47 +00:00
numeric.c * gc.c: support RGENGC. [ruby-trunk - Feature #8339] 2013-05-13 18:07:47 +00:00
object.c * object.c, proc.c: s/call_seq/call-seq in rdoc. [Fix GH-322] 2013-05-31 07:04:33 +00:00
pack.c * *.c, parse.y, insns.def: use RARRAY_AREF/ASET macro 2013-05-13 09:56:22 +00:00
parse.y fill rdocs 2013-06-02 03:12:04 +00:00
prelude.rb
probes.d
probes_helper.h
proc.c * object.c, proc.c: s/call_seq/call-seq in rdoc. [Fix GH-322] 2013-05-31 07:04:33 +00:00
process.c add some rdoc 2013-06-03 02:37:34 +00:00
random.c * gc.c: support RGENGC. [ruby-trunk - Feature #8339] 2013-05-13 18:07:47 +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: use existing functions 2013-05-29 23:57:25 +00:00
re.c * *.c, parse.y, insns.def: use RARRAY_AREF/ASET macro 2013-05-13 09:56:22 +00:00
README * README: Fix typo by Benjamin Winkler [Fixes GH-281] 2013-04-11 00:18:05 +00:00
README.EXT vm_eval.c: new names of rb_funcall family 2013-05-31 08:27:06 +00:00
README.EXT.ja vm_eval.c: new names of rb_funcall family 2013-05-31 08:27:06 +00:00
README.ja
regcomp.c * Merge Onigmo 5.13.4 f22cf2e566712cace60d17f84d63119d7c5764ee. 2013-04-13 11:30:35 +00:00
regenc.c
regenc.h
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
regsyntax.c
ruby.c fix typos. Patch by k_takata. 2013-05-19 03:10:21 +00:00
ruby_atomic.h
safe.c call rb_frame_callee() only once 2013-05-24 22:03:41 +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 * include/ruby/ruby.h: constify RBasic::klass and add 2013-05-13 10:49:11 +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 string.c: remove old interfaces 2013-06-01 01:13:21 +00:00
struct.c * *.c, parse.y, insns.def: use RARRAY_AREF/ASET macro 2013-05-13 09:56:22 +00:00
thread.c * include/ruby/ruby.h, gc.c, vm_trace.c: add internal events. 2013-05-27 00:21:02 +00:00
thread_pthread.c * thread_pthread.c (ruby_init_stack): Add STACK_GROW_DIR_DETECTION. 2013-04-27 11:21:10 +00:00
thread_pthread.h
thread_win32.c
thread_win32.h
time.c fix typos. Patch by k_takata. 2013-05-19 03:10:21 +00:00
timev.h
transcode.c * include/ruby/ruby.h: constify RBasic::klass and add 2013-05-13 10:49:11 +00:00
transcode_data.h
util.c * util.c (ruby_hdtoa): revert r29729. 2013-04-22 02:59:09 +00:00
variable.c no clearing method cache 2013-05-25 02:28:51 +00:00
version.c loadpath.c: split 2013-05-15 07:56:39 +00:00
version.h * 2013-06-03 2013-06-02 15:59:23 +00:00
vm.c fill rdocs 2013-06-02 03:12:04 +00:00
vm_backtrace.c
vm_core.h * include/ruby/debug.h, vm_trace.c: add rb_postponed_job API. 2013-05-26 21:30:44 +00:00
vm_debug.h
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 * vm_eval.c (rb_mod_module_eval): mention in docs that arguments passed 2013-06-01 14:17:14 +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_yield_setup_block_args): partially revert r41019. 2013-06-02 18:44:33 +00:00
vm_insnhelper.h
vm_method.c vm_method.c: extract set_visibility 2013-05-31 02:58:45 +00:00
vm_opts.h fix minor code comment typos 2013-04-22 19:40:10 +00:00
vm_trace.c * vm_trace.c (rb_postponed_job_register_one): fix iteration bug. 2013-05-27 17:08:25 +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: