development fork of ruby/ruby
Перейти к файлу
akr cb61fcb988 update doc.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@27710 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2010-05-09 16:32:52 +00:00
bcc32 * README: update. 2010-05-06 03:12:28 +00:00
benchmark * tool/mkconfig.rb: generate RbConfig.ruby in rbconfig.rb. 2009-12-31 15:00:04 +00:00
bin * bin/erb: removed trailing spaces. 2010-04-02 04:40:34 +00:00
bootstraptest * vm_method.c (rb_unlink_method_entry, rb_sweep_method_entry): 2010-05-05 17:51:21 +00:00
cygwin * cygwin/GNUmakefile.in (RUBYDEF): uses mkexports.rb on cygwin too. 2009-02-02 23:18:30 +00:00
defs removes the dtrace support. reverts r26239, r26238 and r26235. 2010-01-05 05:59:23 +00:00
doc * doc/etc.rd, doc/etc.rd.ja: moved from ext/etc. 2010-04-23 05:07:38 +00:00
enc * properties. 2010-05-07 13:29:44 +00:00
ext update doc. 2010-05-09 16:32:52 +00:00
include * include/ruby/ruby.h (RB_GC_GUARD_PTR): get rid of removal by 2010-05-09 14:53:16 +00:00
lib * lib/net/imap.rb (disconnect): terminates @receiver_thread even if 2010-05-08 23:25:54 +00:00
man * man/*.1: suppressed warnings. 2009-10-26 06:44:31 +00:00
misc * misc/ruby-mode.el (ruby-mode-map): binded C-c C-c and C-c C-c C-u 2010-04-07 14:39:28 +00:00
missing * include/ruby/ruby.h: replace snprintf and vsnprintf by 2010-04-04 01:10:53 +00:00
sample * sample/README: update file list. [ruby-core:28981] 2010-05-03 12:17:04 +00:00
spec * spec/default.mspec (config): . is no longer in $:. 2010-05-08 16:04:22 +00:00
symbian * symbian/setup (config.h): RUBY_EXEC_PREFIX defined. 2010-03-21 15:02:19 +00:00
template * template/fake.rb.in: no need for hook if extmk. 2010-04-24 07:20:28 +00:00
test * test/bigdecimal/test_bigdecimal.rb (TestBigDecimal#test_gc): 2010-05-09 16:00:37 +00:00
tool * tool/rbinstall.rb (install-man): install mdocs directly without 2010-05-07 02:30:57 +00:00
win32 * ext/etc/etc.c (etc_systmpdir): moved from ext/tmpdir. 2010-05-08 03:25:17 +00:00
.cvsignore * .cvsignore: ignore timestamp files and installed list file. 2006-09-21 17:06:50 +00:00
.document * prelude.rb, .document: Stuff in prelude.rb should be documented 2010-03-29 12:48:43 +00:00
.gdbinit * .gdbinit (rb_method_entry): search method entry by class and id. 2009-10-19 06:17:31 +00:00
.gitignore * .gitignore: ignoring fiddle build files 2010-05-07 04:45:27 +00:00
.indent.pro * .indent.pro: added for ruby-style. 2010-03-11 21:50:56 +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 * ext/io/console/console.c (console_set_raw): new method. 2010-05-09 15:54:17 +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 indented. 2010-02-20 03:17:44 +00:00
LEGAL * LEGAL: separated the section for parse.c. contributed by Paul 2010-04-12 12:47:43 +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 (RUBY_PROGRAM_VERSION): added 2010-04-24 07:27:50 +00:00
NEWS * NEWS (io/console): added IO#echo?. 2010-05-09 15:56:58 +00:00
README * README: update. 2010-05-06 03:12:28 +00:00
README.EXT Add more description about Fixnum's size. [ruby-core:27333] 2009-12-30 11:45:32 +00:00
README.EXT.ja * blockinlining.c: removed. 2009-09-17 06:03:39 +00:00
README.ja * README: update. 2010-05-06 03:12:28 +00:00
ToDo * error.c (Init_Exception): remove Exception#to_str. [Ruby2] 2004-04-05 15:55:09 +00:00
array.c * array.c (rb_ary_fetch, rb_ary_splice, rb_ary_store): Improve IndexError 2010-05-08 04:49:53 +00:00
bignum.c * bignum.c (bigmul1_karatsuba): suppress a warning. 2010-04-25 15:08:44 +00:00
class.c * method.h, vm_method.c: rename some internal functions related to 2010-05-04 20:25:09 +00:00
common.mk Add description about make benchmark to make help. 2010-04-27 03:34:45 +00:00
compar.c * string.c: rdoc for <=>, casecmp 2009-10-28 04:50:09 +00:00
compile.c * compile.c (iseq_set_sequence): fix check range of ic_index. 2010-05-05 13:33:58 +00:00
complex.c * complex.c, rational.c, lib/cmath.rb, lib/date.rb lib/date/delta*: 2010-04-26 11:14:40 +00:00
configure.in * configure.in: use AC_TRY_LINK instead of AC_TRY_COMPILE. 2010-04-17 14:27:54 +00:00
cont.c * cont.c (fiber_initialize_machine_stack_context): try to release 2010-05-09 07:28:17 +00:00
debug.c * debug.c (RUBY_NODE_LMASK): may exceed int limit. 2010-05-05 04:31:48 +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 * merge some patches from win32-uncode-test branch. 2010-04-30 17:56:23 +00:00
dln.c * dln.c (aix_loaderror): use execerror for load error on AIX. 2010-05-05 12:55:02 +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
dln_find.c * dln_find.c: split from dln.c. 2010-02-24 00:55:03 +00:00
dmydln.c * dln_find.c: split from dln.c. 2010-02-24 00:55:03 +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
dmyversion.c * dmyversion.c: empty load path in miniruby. 2010-02-08 07:28:00 +00:00
encoding.c * encoding.c (enc_replicate): new encoding name must be valid 2010-04-11 03:08:51 +00:00
enum.c update doc. 2010-03-23 13:59:16 +00:00
enumerator.c * error.c: RDoc for subclasses of Exception. [ruby-core:28394] 2010-05-08 04:50:09 +00:00
error.c * error.c: RDoc for subclasses of Exception. [ruby-core:28394] 2010-05-08 04:50:09 +00:00
eval.c * eval.c (make_exception, rb_obj_extend): Fix error messages in case of wrong 2010-04-30 02:40:57 +00:00
eval_error.c * eval_error.c (error_print): removed an extra argument. 2009-08-06 18:25:11 +00:00
eval_intern.h * iseq.c (iseq_s_disasm): return nil for native methods. 2009-12-23 06:22:48 +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_stat): use STAT macro instead of calling stat() directly. 2010-05-05 06:55:45 +00:00
gc.c * vm_method.c (rb_unlink_method_entry, rb_sweep_method_entry): 2010-05-05 17:51:21 +00:00
gc.h * cont.c (stackgrowdirection): removed duplicated code, use 2010-05-08 16:15:20 +00:00
gem_prelude.rb * gem_prelude.rb (Gem::QuickLoader.load_full_rubygems_library): 2010-04-23 06:31:24 +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 * array.c (rb_ary_fetch, rb_ary_splice, rb_ary_store): Improve IndexError 2010-05-08 04:49:53 +00:00
ia64.s add reference. 2007-07-15 01:41:40 +00:00
id.c * compile.c (iseq_specialized_instruction), insns.def (opt_size): 2009-09-06 08:39:57 +00:00
inits.c * inits.c (rb_call_inits): do not repeat. 2008-11-07 13:52:07 +00:00
insns.def * insns.def (onceinlinecache): add exclusion control for a region 2010-04-27 14:06:16 +00:00
io.c * io.c (nogvl_copy_stream_sendfile): ISO C90 forbids mixed declarations and code. 2010-05-08 22:13:02 +00:00
iseq.c * iseq.c (iseq_load): allow filepath to be nil. 2010-05-02 03:06:44 +00:00
iseq.h * compile.c (ADD_TRACE): fire coverage event in ensure clause. 2009-10-08 16:11:30 +00:00
lex.c.blt * defs/keywords (reserved_word): made inline function static. 2009-05-16 00:30:16 +00:00
load.c * file.c (rb_file_dirname): split from rb_file_s_dirname. 2010-03-30 09:26:09 +00:00
main.c * debug.h (ruby_set_debug_option): declared. 2008-09-23 08:03:41 +00:00
marshal.c * marshal.c (r_object0): should prepare placeholder before 2010-02-24 14:16:59 +00:00
math.c * error.c: RDoc for subclasses of Exception. [ruby-core:28394] 2010-05-08 04:50:09 +00:00
method.h * vm_method.c (rb_unlink_method_entry, rb_sweep_method_entry): 2010-05-05 17:51:21 +00:00
node.c * node.c (dump_node): fixed for long members. 2009-12-09 15:46:45 +00:00
node.h * bignum.c, node.h, strftime.c, enc/trans/utf8_mac.trans: added explicit casts for supplessing warnings. 2010-03-25 03:08:28 +00:00
numeric.c * error.c: RDoc for subclasses of Exception. [ruby-core:28394] 2010-05-08 04:50:09 +00:00
object.c * object.c (rb_cstr_to_dbl): return 0.0 if hexadecimal and 2010-04-01 04:32:43 +00:00
pack.c add comment. 2010-03-11 13:39:29 +00:00
parse.y * parse.y (warn_balanced): do not warn for EXPR_ENDFN. 2010-04-28 00:43:27 +00:00
prelude.rb Fix :nodoc: definition. [ruby-dev:40949] 2010-04-10 22:09:09 +00:00
proc.c * proc.c (proc_dup): copy blockprocval. proc_dup is used by 2010-05-09 14:51:43 +00:00
process.c * eval.c (make_exception, rb_obj_extend): Fix error messages in case of wrong 2010-04-30 02:40:57 +00:00
random.c * random.c (make_seed_value): fix leading-zero-guard condition on 2010-04-13 06:00:49 +00:00
range.c * range.c (discrete_object_p): needs the argument type to get rid 2009-10-02 15:31:05 +00:00
rational.c * complex.c, rational.c, lib/cmath.rb, lib/date.rb lib/date/delta*: 2010-04-26 11:14:40 +00:00
re.c * error.c: RDoc for subclasses of Exception. [ruby-core:28394] 2010-05-08 04:50:09 +00:00
regcomp.c * regcomp.c (noname_disable_map): add NT_ANCHOR case. 2010-03-02 09:40:27 +00:00
regenc.c * regenc.h (PosixBracketEntryType): constified. 2009-09-22 07:28:43 +00:00
regenc.h * include/ruby/oniguruma.h: updated to follow Oniguruma 5.9.2. 2010-03-01 21:54:59 +00:00
regerror.c * removed spaces just before tabs. 2009-11-26 05:25:08 +00:00
regexec.c * include/ruby/oniguruma.h: updated to follow Oniguruma 5.9.2. 2010-03-01 21:54:59 +00:00
regint.h * include/ruby/oniguruma.h: updated to follow Oniguruma 5.9.2. 2010-03-01 21:54:59 +00:00
regparse.c * include/ruby/oniguruma.h: updated to follow Oniguruma 5.9.2. 2010-03-01 21:54:59 +00:00
regparse.h *regparse.c (CC_DUP_WARN): use rb_compile_warn if ScanEnv has source 2009-08-30 08:00:31 +00:00
regsyntax.c stripped trailing spaces. 2009-02-22 14:23:33 +00:00
ruby.c * ruby.c (get_arglen): skip the last terminator of argv before 2010-04-24 04:06:59 +00:00
safe.c * file.c (rb_get_path_check): check with given safe level. 2009-06-23 12:28:16 +00:00
signal.c * signal.c (ruby_signal_name): rdoc fix for undocumented parameter 2010-04-30 04:35:16 +00:00
sprintf.c * include/ruby/ruby.h: replace snprintf and vsnprintf by 2010-04-04 01:10:53 +00:00
st.c * st.c (st_foreach): don't access ptr->hash after func call. 2010-02-15 13:45:52 +00:00
strftime.c * time.c: less bignum allocations. 2010-03-31 12:34:31 +00:00
string.c * string.c (rb_str_match_m): add description about optional 2010-05-06 06:07:05 +00:00
struct.c * include/ruby/ruby.h (rb_long2int): evalates the argument only 2009-10-07 07:06:32 +00:00
thread.c * thread.c (rb_thread_aset): fixed argument type. 2010-05-08 15:27:48 +00:00
thread_pthread.c * cont.c (stackgrowdirection): removed duplicated code, use 2010-05-08 16:15:20 +00:00
thread_pthread.h * thread_pthread.c (native_thread_init_stack): use get_stack. 2010-02-04 07:17:03 +00:00
thread_win32.c * thread_win32.c (w32_wait_events): get GVL before handle interrupt 2010-05-05 11:53:03 +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 (rb_localtime_r2): get rid of infinite loop bug of 2010-05-06 08:16:45 +00:00
timev.h * timev.h (TIME_SCALE): defined as 1000000000. 2009-08-29 19:06:29 +00:00
transcode.c * error.c: RDoc for subclasses of Exception. [ruby-core:28394] 2010-05-08 04:50:09 +00:00
transcode_data.h * transcode_data.h, transcode.c, tool/transcode-tblgen.rb: Added 2009-12-10 11:59:12 +00:00
util.c * util.c (BSD__hdtoa): suppress a warning. 2010-04-01 21:59:57 +00:00
variable.c * ruby.c (ruby_init_loadpath_safe, ruby_init_gems): set and remove 2010-03-11 22:15:11 +00:00
version.c * vm.c (vm_backtrace_each): get rid of use of malloc from signal 2010-04-15 05:38:07 +00:00
version.h * ext/io/console/console.c (ttymode): reverted previous commit. 2010-05-09 15:35:43 +00:00
vm.c * vm_method.c (rb_unlink_method_entry, rb_sweep_method_entry): 2010-05-05 17:51:21 +00:00
vm_core.h * vm_method.c (rb_unlink_method_entry, rb_sweep_method_entry): 2010-05-05 17:51:21 +00:00
vm_dump.c * vm_dump.c (bugreport_backtrace): ditto. 2010-04-15 05:50:24 +00:00
vm_eval.c * vm.c (vm_backtrace_each): get rid of use of malloc from signal 2010-04-15 05:38:07 +00:00
vm_exec.c * vm_exec.c (DECL_SC_REG): use __clang__. 2009-10-27 00:29:06 +00:00
vm_exec.h removes the dtrace support. reverts r26239, r26238 and r26235. 2010-01-05 05:59:23 +00:00
vm_insnhelper.c * vm_insnhelper.c (vm_call_bmethod): removed unused variable. 2010-05-08 16:22:33 +00:00
vm_insnhelper.h * vm_insnhelper.h (GET_BLOCK_PTR): return 0 when in class frame. 2010-01-11 09:33:37 +00:00
vm_method.c * vm_method.c (rb_unlink_method_entry, rb_sweep_method_entry): 2010-05-05 17:51:21 +00:00
vm_opts.h * vm_opts.h: enable "OPT_TRACE_INSTRUCTION" on default. 2008-08-23 06:18:11 +00:00
vsnprintf.c * vsnprintf.c (ruby_vsnprintf, ruby_snprintf): suppress warnings. 2010-04-28 01:27:37 +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'

     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}/${PLATFORM}
       * ${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}/${PLATFORM}
       * ${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.


* 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: