development fork of ruby/ruby
Перейти к файлу
akr e7ba39350a rdoc update.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@23420 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2009-05-13 10:36:52 +00:00
bcc32 * configure.in, */Makefile.sub (LOAD_RELATIVE): moved from ruby.c 2009-02-19 05:48:14 +00:00
benchmark * runruby.rb: use RbConfig::CONFIG instead of Config::CONFIG. 2009-04-30 12:25:23 +00:00
bin * bin/{irb,rdoc}: executable. 2009-03-26 01:31:24 +00:00
bootstraptest * bootstraptest/test_io.rb: test for [ruby-dev:38131]. 2009-04-26 09:44:35 +00:00
cygwin * cygwin/GNUmakefile.in (RUBYDEF): uses mkexports.rb on cygwin too. 2009-02-02 23:18:30 +00:00
defs * keywords, lex.c.src, opt_insn_unif.def, opt_operand.def: moved rarely changed 2008-10-18 22:30:13 +00:00
doc Update with branches/ruby_1_9_1/NEWS. 2009-02-12 15:04:41 +00:00
enc Fix: DON'T move in_p because before in_p is replaced by buffered data. 2009-05-05 00:05:11 +00:00
ext * ext/bigdecimal/bigdecimal.c (BigDecimal_coerce): support 2009-05-10 23:59:10 +00:00
include * include/ruby/version.h: extracted the extensions interface and 2009-05-13 06:23:20 +00:00
lib * lib/net/smtp.rb (Net::SMTP#check_auth_args): should not change 2009-05-10 23:56:22 +00:00
man * man/ri.1: new manpage. 2008-12-29 12:14:25 +00:00
misc * lib/irb/completion.rb (IRB::InputCompletor::Operators): Add 2009-04-03 05:04:02 +00:00
missing * array.c, bignum.c, dln.c, error.c, gc.c, io.c, marshal.c, 2009-03-12 09:16:15 +00:00
sample * sample/test.rb (valid_syntax?), test/ruby/test_system.rb 2009-02-02 03:39:01 +00:00
spec * runruby.rb: use RbConfig::CONFIG instead of Config::CONFIG. 2009-04-30 12:25:23 +00:00
symbian * symbian/setup (config.h): added TIMET2NUM and NUM2TIMET to match the change in time.c 2009-04-20 15:11:46 +00:00
template * template/fake.rb.in: extracted from Makefile.in. 2009-02-19 06:47:13 +00:00
test add test. 2009-05-12 18:00:25 +00:00
tool Fix: raised error on tool/ifchange. 2009-05-05 02:33:02 +00:00
win32 * Makefile.in, configure.in, win32/Makefile.sub (RUBY_BASE_NAME): 2009-05-08 01:14:14 +00:00
.cvsignore * .cvsignore: ignore timestamp files and installed list file. 2006-09-21 17:06:50 +00:00
.document Support "require" as variable name in RDoc 2004-10-10 03:35:51 +00:00
.gdbinit * .gdbinit (rp): show negative fixnum correctly. 2009-03-30 10:04:51 +00:00
.gitignore * svn:ignore, .gitignore: merged. 2009-05-05 08:49:55 +00:00
COPYING * sprintf.c (rb_str_format): allow %c to print one character 2006-06-09 21:20:17 +00:00
COPYING.ja * ext/bigdecimal/lib/bigdecimal/newton.rb (Newton::nlsolve): typo 2006-06-10 16:09:12 +00:00
ChangeLog * include/ruby/version.h: extracted the extensions interface and 2009-05-13 06:23:20 +00:00
Doxyfile.in * common.mk (Doxyfile): moved from Makefile.in. 2009-02-02 23:10:28 +00:00
GPL * It is confusing to put the GPL license terms in the file COPYING; 2001-07-11 19:25:52 +00:00
KNOWNBUGS.rb add timeout. 2009-02-14 22:30:56 +00:00
LEGAL Commit miss at r21521, poited out by Yugui. 2009-01-16 05:12:59 +00:00
LGPL * It is confusing to put the GPL license terms in the file COPYING; 2001-07-11 19:25:52 +00:00
Makefile.in * Makefile.in, configure.in, win32/Makefile.sub (RUBY_BASE_NAME): 2009-05-08 01:14:14 +00:00
NEWS * time.c: support fixed UTC offset. [ruby-dev:38326] 2009-05-12 12:07:49 +00:00
README * README, README.ja: Update the portability section. 2008-10-29 04:20:42 +00:00
README.EXT describe more conversion functions between integer and VALUE. 2009-05-09 05:04:25 +00:00
README.EXT.ja describe more conversion functions between integer and VALUE. 2009-05-09 05:04:25 +00:00
README.ja * README.ja: code for THINK_C does not exist already. [Bug #1435] 2009-05-06 00:27:10 +00:00
ToDo * error.c (Init_Exception): remove Exception#to_str. [Ruby2] 2004-04-05 15:55:09 +00:00
array.c rename argument name. 2009-05-09 05:44:20 +00:00
bignum.c * bignum.c (bigsub_int): subtraction without making internal 2009-04-20 17:53:36 +00:00
blockinlining.c stripped trailing spaces. 2009-02-22 14:23:33 +00:00
class.c * class.c (rb_define_method_id): use rb_define_notimplement_method_id 2009-04-16 14:17:14 +00:00
common.mk * eval.c (ruby_cleanup): the order of local variables on stack is 2009-04-19 05:43:20 +00:00
compar.c stripped trailing spaces. 2009-02-22 14:23:33 +00:00
compile.c * compile.c (cdhash_type, iseq_set_sequence): should not call 2009-02-27 09:30:53 +00:00
complex.c * complex.c (f_signbit): fixed indentation. 2009-02-15 17:39:38 +00:00
config.guess * config.guess ({powerpc-apple,i586-pc}-haiku): re-applied r18403. 2008-08-10 03:34:44 +00:00
config.sub * config.{guess,sub}: updated to automake-1.10.1. 2008-08-10 03:29:21 +00:00
configure.in * Makefile.in, configure.in, win32/Makefile.sub (RUBY_BASE_NAME): 2009-05-08 01:14:14 +00:00
cont.c stripped trailing spaces. 2009-02-22 14:23:33 +00:00
debug.c stripped trailing spaces. 2009-02-22 14:23:33 +00:00
debug.h * include/ruby/node.h, node.h: move node.h from include path. 2008-09-23 19:52:31 +00:00
dir.c * dir.c (glob_helper): C99(gcc)-ism. 2009-04-22 01:40:09 +00:00
dln.c * dir.c, dln.c, parse.y, re.c, ruby.c, sprintf.c, strftime.c, 2009-03-17 01:29:17 +00:00
dln.h * dln.c (init_funcname_len, dln_find_exe_r, dln_find_file_r): use 2009-03-14 01:56:15 +00:00
dmydln.c * Makefile.in, common.mk: miniruby depens on MINIOBJS. 2005-04-20 14:25:34 +00:00
dmyencoding.c * encoding.c (enc_init_db): moved to enc/encdb.c. 2008-04-07 06:51:33 +00:00
dmyext.c * array.c: moved to ANSI function style from K&R function style. 2005-09-12 10:44:21 +00:00
encoding.c * encoding.c (rb_filesystem_encoding): Change filesystem_encoding of 2009-04-30 02:38:47 +00:00
enum.c stripped trailing spaces. 2009-02-22 14:23:33 +00:00
enumerator.c Trivial change in comment. 2009-04-22 16:32:43 +00:00
error.c * io.c (rb_mWaitReadable): defined. 2009-03-19 11:40:38 +00:00
eval.c * eval.c (ruby_cleanup): the order of local variables on stack is 2009-04-19 05:43:20 +00:00
eval_error.c * eval_error.c (error_print): use volatile to suppress warnings. 2009-02-28 11:12:36 +00:00
eval_intern.h * eval_intern.h (_longjmp): never return. see [ruby-core:23241] 2009-05-01 04:18:02 +00:00
eval_jump.c * eval_error.c (error_print): use volatile to suppress warnings. 2009-02-28 11:12:36 +00:00
file.c * file.c (rb_file_join): recursive array has no meaning as path 2009-04-29 06:22:29 +00:00
gc.c * eval.c (ruby_cleanup): the order of local variables on stack is 2009-04-19 05:43:20 +00:00
gc.h * gc.h (STACK_UPPER): moved from gc.c 2008-06-14 02:59:19 +00:00
gem_prelude.rb * gem_prelude.rb (Gem::QuickLoader#push_gem_version_on_load_path): 2009-04-19 04:17:26 +00:00
golf_prelude.rb make ./goruby -e 'p "abc".gs(/a/) { $& }' prints "abc". 2009-03-17 06:40:20 +00:00
goruby.c stripped trailing spaces. 2009-02-22 14:23:33 +00:00
hash.c * hash.c: 3rd arguemnt of rb_hash_foreach() is VALUE. 2009-05-09 03:19:52 +00:00
ia64.s add reference. 2007-07-15 01:41:40 +00:00
id.c stripped trailing spaces. 2009-02-22 14:23:33 +00:00
id.h * template/id.h.tmpl, id.h (ruby_method_ids_check): enclosed in a 2008-12-24 20:53:06 +00:00
inits.c * inits.c (rb_call_inits): do not repeat. 2008-11-07 13:52:07 +00:00
insns.def * array.c, bignum.c, gc.c, numeric.c, string.c, util.c, insns.def, 2009-03-10 05:43:14 +00:00
install-sh 1.4.0 1999-08-13 05:45:20 +00:00
instruby.rb * ext/extmk.rb: use RbConfig instead of Config. 2009-04-30 16:34:01 +00:00
io.c * io.c (Init_IO): add constant File::NOATIME. [ruby-core:23194] 2009-05-11 11:11:11 +00:00
iseq.c * iseq.c (rb_iseq_disasm): RSTRING_LEN() returns long. 2009-03-11 20:19:24 +00:00
iseq.h * iseq.c: 2009-01-19 01:06:56 +00:00
lex.c.blt * parse.y (primary): make functional-style not operator to act 2008-06-25 12:55:47 +00:00
load.c stripped trailing spaces. 2009-02-22 14:23:33 +00:00
main.c * debug.h (ruby_set_debug_option): declared. 2008-09-23 08:03:41 +00:00
marshal.c * array.c, bignum.c, dln.c, error.c, gc.c, io.c, marshal.c, 2009-03-12 09:16:15 +00:00
math.c rdoc update. 2009-05-13 10:36:52 +00:00
mkconfig.rb * mkconfig.rb (rubylibdir): use rubylibprefix. [ruby-dev:38426] 2009-05-11 04:08:32 +00:00
node.h * node.h (rb_notimplement_body_p): declared. 2009-04-16 16:58:06 +00:00
numeric.c * numeric.c (flo_to_s): reduce fragments if no precision lost. 2009-04-06 16:08:23 +00:00
object.c stripped trailing spaces. 2009-02-22 14:23:33 +00:00
pack.c * array.c, bignum.c, dln.c, error.c, gc.c, io.c, marshal.c, 2009-03-12 09:16:15 +00:00
parse.y * parse.y: add semicolons to some grammar rules not terminated 2009-05-11 13:54:59 +00:00
prelude.rb * prelude.rb (require_relative): move require_relative from 2008-04-12 14:50:18 +00:00
proc.c * class.c (rb_define_method_id): use rb_define_notimplement_method_id 2009-04-16 14:17:14 +00:00
process.c * process.c (proc_setegid): define only if needed. 2009-04-25 10:28:25 +00:00
random.c * random.c (fill_random_seed): enclosed conditionally used 2009-03-11 20:14:51 +00:00
range.c * range.c (r_le): fixed types. 2009-05-07 05:01:56 +00:00
rational.c * string.c (rb_hash_uint32, rb_hash_uint, rb_hash_start, rb_hash_end), 2009-02-14 19:55:34 +00:00
re.c * dir.c, dln.c, parse.y, re.c, ruby.c, sprintf.c, strftime.c, 2009-03-17 01:29:17 +00:00
regcomp.c stripped trailing spaces. 2009-02-22 14:23:33 +00:00
regenc.c stripped trailing spaces. 2009-02-22 14:23:33 +00:00
regenc.h * id.h, include/ruby/{intern,oniguruma}.h, regenc.h, regparse.h, 2008-12-09 07:14:13 +00:00
regerror.c stripped trailing spaces. 2009-02-22 14:23:33 +00:00
regexec.c stripped trailing spaces. 2009-02-22 14:23:33 +00:00
regint.h * thread.c (rb_thread_check_ints): added. please note that 2008-08-13 08:21:24 +00:00
regparse.c stripped trailing spaces. 2009-02-22 14:23:33 +00:00
regparse.h * id.h, include/ruby/{intern,oniguruma}.h, regenc.h, regparse.h, 2008-12-09 07:14:13 +00:00
regsyntax.c stripped trailing spaces. 2009-02-22 14:23:33 +00:00
ruby.c * dir.c, dln.c, parse.y, re.c, ruby.c, sprintf.c, strftime.c, 2009-03-17 01:29:17 +00:00
rubytest.rb * common.mk (test-sample), rubytest.rb: use runruby.rb 2009-01-09 03:29:10 +00:00
runruby.rb * runruby.rb: use RbConfig::CONFIG instead of Config::CONFIG. 2009-04-30 12:25:23 +00:00
safe.c * safe.c (safe_setter): add warning for $SAFE=3. 2008-11-07 20:35:10 +00:00
signal.c * signal.c (sig_trap): suppress warnings. 2009-03-10 19:22:11 +00:00
sprintf.c * sprintf.c (rb_str_format): scan coderange incrementally. 2009-04-13 08:21:41 +00:00
st.c * st.c: use st_index_t for indexes instead of int. 2009-03-12 08:56:31 +00:00
strftime.c * time.c: support fixed UTC offset. [ruby-dev:38326] 2009-05-12 12:07:49 +00:00
string.c rdoc update. 2009-05-09 11:01:47 +00:00
struct.c stripped trailing spaces. 2009-02-22 14:23:33 +00:00
thread.c * thread.c: fixed types. 2009-05-09 03:25:16 +00:00
thread_pthread.c * eval.c (ruby_cleanup): the order of local variables on stack is 2009-04-19 05:43:20 +00:00
thread_pthread.h * eval_intern.h, insnhelper.h, thread_pthread.h, vm_core.h, vm_opts.h: 2008-01-18 08:56:11 +00:00
thread_win32.c * eval.c (ruby_cleanup): the order of local variables on stack is 2009-04-19 05:43:20 +00:00
thread_win32.h * thread_win32.[ch] (cond_every_entry, rb_thread_cond_struct): reverted 2008-07-28 12:27:43 +00:00
time.c * time.c (time_init_1): unused variable removed. 2009-05-12 18:21:18 +00:00
timev.h * time.c: remove time_t restriction from Time class. 2009-04-21 14:56:59 +00:00
transcode.c Fix: DON'T move in_p because before in_p is replaced by buffered data. 2009-05-05 00:05:11 +00:00
transcode_data.h Fix: DON'T move in_p because before in_p is replaced by buffered data. 2009-05-05 00:05:11 +00:00
util.c * dir.c, dln.c, parse.y, re.c, ruby.c, sprintf.c, strftime.c, 2009-03-17 01:29:17 +00:00
variable.c * variable.c (rb_autoload_load): suppress a warning. 2009-05-09 03:37:00 +00:00
version.c * configure.in (RUBY_LIB_VERSION): added for library version, to 2009-02-05 02:21:37 +00:00
version.h * include/ruby/version.h: extracted the extensions interface and 2009-05-13 06:23:20 +00:00
vm.c * vm.c (rb_vm_get_sourceline), vm_insnhelper.c (vm_throw): use 2009-03-12 09:02:06 +00:00
vm_core.h * array.c (rb_ary_resurrect), string.c (rb_str_resurrect): new 2009-02-18 05:33:36 +00:00
vm_dump.c * vm_dump.c (rb_vm_bugreport): should not #include inside a 2009-04-01 09:53:52 +00:00
vm_eval.c * vm_eval.c (rb_f_catch): gets rid of issue with gcc 4.4. a patch 2009-05-09 02:14:52 +00:00
vm_exec.c * vm.c: add a prefix "rb_" to exposed functions 2009-01-19 02:38:11 +00:00
vm_exec.h * vm_dump.c: add a prefix "rb_vmdebug_" to 2009-01-19 02:09:43 +00:00
vm_insnhelper.c * vm.c (rb_vm_get_sourceline), vm_insnhelper.c (vm_throw): use 2009-03-12 09:02:06 +00:00
vm_insnhelper.h * vm.c (rb_vm_inc_const_missing_count, ruby_vm_const_missing_count): 2009-01-15 15:31:43 +00:00
vm_method.c update rdoc. 2009-04-21 18:41:07 +00:00
vm_opts.h * vm_opts.h: enable "OPT_TRACE_INSTRUCTION" on default. 2008-08-23 06:18:11 +00:00

README

* 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://redmine.ruby-lang.org/wiki/ruby-19/SupportedPlatforms


* How to get Ruby

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

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/


* 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 <ruby-talk-ctl@ruby-lang.org>.


* How to compile and install

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

  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 optflags=.. and warnflags=.. as necessary
     to override them.

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

  4. 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 does not allow dynamic loading),
     remove comment mark from the line "#option nodynamic" in
     ext/Setup.

  5. Run make.

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

  7. Run 'make install'

     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.


* Copying

See the file COPYING.


* The Author

Feel free to send comments and bug reports to the author.  Here is the 
author's latest mail address:

  matz@netlab.jp

-------------------------------------------------------
created at: Thu Aug  3 11:57:36 JST 1995
Local variables:
mode: indented-text
end: