development fork of ruby/ruby
Перейти к файлу
akr b698066bbd update doc.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@28684 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2010-07-19 11:36:23 +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 * lib/test/unit.rb (MiniTest::Unit#process_args): refactored. 2010-07-17 10:01:49 +00:00
bootstraptest * bootstraptest/test_class.rb: add a test for [ruby-core:30843]. 2010-06-27 18:13:06 +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 Mention the json library. (Pointed out by yhara) 2010-07-14 10:04:02 +00:00
enc * enc/trans/utf8_mac.trans (buf_apply): fix for patterns 2010-06-12 17:13:54 +00:00
ext * ext/pathname/pathname.c (get_strpath): check the type. 2010-07-19 09:35:31 +00:00
include * include/ruby/ruby.h (rb_data_type_t): add new feature macros. 2010-07-18 20:46:13 +00:00
lib * lib/test/unit.rb (MiniTest::Unit#process_args): refactored. 2010-07-17 10:01:49 +00:00
man * man/*.1: suppressed warnings. 2009-10-26 06:44:31 +00:00
misc * misc/ruby-mode.el (ruby-mode-set-encoding): commit miss. 2010-05-31 09:27:06 +00:00
missing * missing/close.c: keep original errno. 2010-07-13 04:15:30 +00:00
sample * test/ruby/test_system.rb (test_syntax2): moved from sample/test.rb 2010-07-04 12:01:46 +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 * id.c (Init_id): add underscore name. 2010-06-20 07:17:46 +00:00
test * lib/test/unit.rb (MiniTest::Unit#process_args): refactored. 2010-07-17 10:01:49 +00:00
tool * tool/file2lastrev.rb: don't depend on pathname.rb if File.realpath 2010-07-17 09:30:54 +00:00
win32 * configure.in (enable-debug-env): option for RUBY_DEBUG env. 2010-06-26 04:07:20 +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 (rp): show type name for RTypedData. 2010-06-05 07:39:47 +00:00
.gitignore * .gitignore: updated. 2010-05-17 12:31:21 +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/pathname/pathname.c (get_strpath): check the type. 2010-07-19 09:35:31 +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
Makefile.in * Makefile.in ({,dist-,real-}clean-ext): should also omit 2010-07-11 08:01:59 +00:00
NEWS * NEWS (Kernel#instance_eval): add an incompatible change since 2010-07-19 00:01:02 +00:00
README * README: update. 2010-05-06 03:12:28 +00:00
README.EXT * README.EXT{,.ja} (rb_block_call): fixed about third/fourth 2010-07-11 12:20:28 +00:00
README.EXT.ja * README.EXT{,.ja} (rb_block_call): fixed about third/fourth 2010-07-11 12:20:28 +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_clear): should not unshare embedded array, and 2010-07-19 03:33:33 +00:00
bignum.c * removed trailing spaces. 2010-05-29 18:51:39 +00:00
class.c * class.c (rb_mod_init_copy): when class is dup'ed, a metaclass of the 2010-06-27 17:47:21 +00:00
common.mk * common.mk (test-knownbug): ignore known bugs. 2010-07-01 04:00:56 +00:00
compar.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
compile.c * compile.c (iseq_compile_each): should consider block on stack, 2010-06-02 03:05:06 +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: fix for universal binary. 2010-07-13 12:26:16 +00:00
cont.c * include/ruby/ruby.h (rb_data_type_t): restructured. [ruby-dev:41862] 2010-07-18 07:31:54 +00:00
debug.c * suppress warnings. 2010-05-21 09:10:23 +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 * include/ruby/ruby.h (rb_data_type_t): restructured. [ruby-dev:41862] 2010-07-18 07:31:54 +00:00
dln.c * suppress warnings. 2010-05-21 09:10:23 +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 * include/ruby/ruby.h (rb_data_type_t): restructured. [ruby-dev:41862] 2010-07-18 07:31:54 +00:00
enum.c * enum.c (zip): rdoc fix, patch by okkez [ruby-dev:41737] 2010-06-27 03:10:20 +00:00
enumerator.c * include/ruby/ruby.h (rb_data_type_t): restructured. [ruby-dev:41862] 2010-07-18 07:31:54 +00:00
error.c * include/ruby/ruby.h (rb_data_type_t): restructured. [ruby-dev:41862] 2010-07-18 07:31:54 +00:00
eval.c * eval.c (frame_func_id), vm_eval.c (rb_iterate), 2010-07-14 11:23:10 +00:00
eval_error.c * eval_error.c (error_print): clear raised_flag while error-printing 2010-06-21 14:43:58 +00:00
eval_intern.h * load.c (rb_load_internal): remove call to rb_realpath_internal 2010-06-17 14:32:20 +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 * include/ruby/ruby.h (rb_data_type_t): restructured. [ruby-dev:41862] 2010-07-18 07:31:54 +00:00
gc.c * include/ruby/ruby.h (rb_data_type_t): restructured. [ruby-dev:41862] 2010-07-18 07:31:54 +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: provide workaround for gem activation. Currently, 2010-07-07 15:40:52 +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: Documentation: change => in call-seq to ->. 2010-05-17 21:31:22 +00:00
ia64.s add reference. 2007-07-15 01:41:40 +00:00
id.c * id.c (Init_id): add underscore name. 2010-06-20 07:17:46 +00:00
inits.c * inits.c (rb_call_inits): do not repeat. 2008-11-07 13:52:07 +00:00
insns.def * insns.def (concatarray): removed unused variable. 2010-06-03 09:40:25 +00:00
io.c * io.c (nogvl_copy_stream_sendfile): jump to retry_sendfile directly 2010-07-06 13:59:12 +00:00
iseq.c * include/ruby/ruby.h (rb_data_type_t): restructured. [ruby-dev:41862] 2010-07-18 07:31:54 +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 * ruby.c: add prototype of rb_realpath_internal. 2010-06-18 01:16:13 +00:00
main.c * debug.h (ruby_set_debug_option): declared. 2008-09-23 08:03:41 +00:00
marshal.c * include/ruby/ruby.h (rb_data_type_t): restructured. [ruby-dev:41862] 2010-07-18 07:31:54 +00:00
math.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +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 * cont.c (fiber_set_stack_location), iseq.c (prepare_iseq_build), 2010-05-16 02:46:16 +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 * numeric.c (fix_divide): must not use rb_rational_new1 for coercion 2010-07-15 12:55:23 +00:00
object.c * object.c (rb_f_integer): add example with base. 2010-07-06 22:02:25 +00:00
pack.c update doc. 2010-06-28 13:05:07 +00:00
parse.y * include/ruby/ruby.h (rb_data_type_t): restructured. [ruby-dev:41862] 2010-07-18 07:31:54 +00:00
prelude.rb Fix :nodoc: definition. [ruby-dev:40949] 2010-04-10 22:09:09 +00:00
proc.c * include/ruby/ruby.h (rb_data_type_t): restructured. [ruby-dev:41862] 2010-07-18 07:31:54 +00:00
process.c * process.c (rb_daemon): split from proc_daemon. 2010-07-13 12:31:17 +00:00
random.c * random.c (DEFAULT_SEED_LEN): suppress a warning. 2010-07-19 05:45:14 +00:00
range.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +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 * re.c (rb_reg_expr_str): ASCII incompatible strings 2010-06-05 11:32:05 +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 * regexec.c (onig_search): don't skip non-ANYCHARs when 2010-07-15 06:55:42 +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 * regparse.c (onig_syntax_warn): do not use external strings as 2010-05-31 10:26:01 +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 * include/ruby/io.h, io.c: reverted r21709. 2010-06-27 14:31:19 +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 * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
sprintf.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +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 * strftime.c (rb_strftime_with_timespec): fix precision handling for 2010-07-10 12:43:54 +00:00
string.c * string.c (rb_str_conv_enc_opts): fix infinite loop because 2010-07-08 08:18:07 +00:00
struct.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
thread.c * include/ruby/ruby.h (rb_data_type_t): restructured. [ruby-dev:41862] 2010-07-18 07:31:54 +00:00
thread_pthread.c * thread_pthread.c (thread_start_func_1): don't call 2010-07-01 07:25: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 * vm.c (Init_BareVM): call Init_native_thread here. 2010-06-05 23:26:43 +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 update doc. 2010-07-19 11:36:23 +00:00
timev.h * timev.h (TIME_SCALE): defined as 1000000000. 2009-08-29 19:06:29 +00:00
transcode.c * include/ruby/ruby.h (rb_data_type_t): restructured. [ruby-dev:41862] 2010-07-18 07:31:54 +00:00
transcode_data.h * gc.c (gc_lazy_sweep): clean a warning. 2010-06-18 01:44:52 +00:00
util.c * util.c (ruby_add_suffix): fixed type warnings. 2010-07-17 05:10:22 +00:00
variable.c * include/ruby/ruby.h (rb_data_type_t): restructured. [ruby-dev:41862] 2010-07-18 07:31:54 +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 * include/ruby/ruby.h (rb_data_type_t): add new feature macros. 2010-07-18 20:46:13 +00:00
vm.c * include/ruby/ruby.h (rb_data_type_t): restructured. [ruby-dev:41862] 2010-07-18 07:31:54 +00:00
vm_core.h * vm_core.c (rb_thread_struct): add a field for sigaltstack. 2010-05-13 16:20:26 +00:00
vm_dump.c * eval_intern.h (rb_vm_get_sourceline): add prototype. 2010-05-11 00:57:09 +00:00
vm_eval.c * eval.c (frame_func_id), vm_eval.c (rb_iterate), 2010-07-14 11:23:10 +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 * eval.c (frame_func_id), vm_eval.c (rb_iterate), 2010-07-14 11:23:10 +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_method_boundp): respond_to?(:protected_method, 2010-07-07 04:06:32 +00:00
vm_opts.h * vm_opts.h: enable "OPT_TRACE_INSTRUCTION" on default. 2008-08-23 06:18:11 +00:00
vsnprintf.c * removed trailing spaces. 2010-05-29 18:51:39 +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: