development fork of ruby/ruby
Перейти к файлу
naruse f3372c22a6 * common.mk (clean): add prelude.c, config.log, and rbconfig.rb.
* common.mk (distclean): remove encdb.h, config.log, and rbconfig.rb.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@28882 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2010-08-06 08:40:30 +00:00
bcc32 * configure.in (config.h): add include guard. 2010-07-26 09:18:21 +00:00
benchmark
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
defs
doc Mention the json library. (Pointed out by yhara) 2010-07-14 10:04:02 +00:00
enc * Makefile.in: ignore error from RMDIRS. 2010-08-06 08:40:27 +00:00
ext * ext/pathname/pathname.c (path_mtime): Pathname#mtime translated from 2010-08-05 20:53:56 +00:00
include * hash.c (rb_check_hash_type): added. 2010-08-03 12:01:13 +00:00
lib * Makefile.in: ignore error from RMDIRS. 2010-08-06 08:40:27 +00:00
man
misc * misc/ruby-mode.el (ruby-mode-set-encoding): commit miss. 2010-05-31 09:27:06 +00:00
missing * missing/*.c: include missing.h 2010-07-28 08:12:01 +00:00
sample * test/ruby/test_system.rb (test_syntax2): moved from sample/test.rb 2010-07-04 12:01:46 +00:00
spec * ext/mkext.rb: remove purelib, fixes a bug in r28440, r28441. 2010-08-03 05:48:05 +00:00
symbian
template * ext/mkext.rb: remove purelib, fixes a bug in r28440, r28441. 2010-08-03 05:48:05 +00:00
test * compile.c (NODE_ARGSCAT, NODE_ARGSPUSH): drop unused ARGSCAT 2010-08-05 12:32:02 +00:00
tool * tool/runruby.rb: no purelib. 2010-08-03 03:05:39 +00:00
win32 * win32/Makefile.sub: needs stddef.h for size_t. a patch from 2010-08-01 08:27:34 +00:00
.cvsignore
.document
.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
COPYING
COPYING.ja
ChangeLog * common.mk (clean): add prelude.c, config.log, and rbconfig.rb. 2010-08-06 08:40:30 +00:00
GPL
KNOWNBUGS.rb
LEGAL * LEGAL: separated the section for parse.c. contributed by Paul 2010-04-12 12:47:43 +00:00
Makefile.in * Makefile.in: ignore error from RMDIRS. 2010-08-06 08:40:27 +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, README.EXT.ja (String functions): mention 2010-08-05 11:14:05 +00:00
README.EXT.ja * README.EXT, README.EXT.ja (String functions): mention 2010-08-05 11:14:05 +00:00
README.ja * README: update. 2010-05-06 03:12:28 +00:00
ToDo
array.c * array.c (rb_ary_clear): should not unshare embedded array, and 2010-07-19 03:33:33 +00:00
bignum.c * bignum.c (rb_big_eq): never equal to infinity. 2010-08-03 11:30:19 +00:00
class.c * class.c (rb_include_module): don't clear the method cache if the 2010-08-01 00:46:18 +00:00
common.mk * common.mk (clean): add prelude.c, config.log, and rbconfig.rb. 2010-08-06 08:40:30 +00:00
compar.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
compile.c * compile.c (NODE_ARGSCAT, NODE_ARGSPUSH): drop unused ARGSCAT 2010-08-05 12:32:02 +00:00
complex.c * complex.c (nucomp_marshal_load): should check the argument. 2010-08-05 09:36:16 +00:00
configure.in * ext/purelib.rb: no longer used since the default load path of 2010-08-02 22:52:25 +00:00
cont.c * cont.c: typos. 2010-07-28 00:38:21 +00:00
debug.c * suppress warnings. 2010-05-21 09:10:23 +00:00
debug.h * configure.in (XCFLAGS): use -fvisibility=hidden if possible. 2010-07-21 21:38:25 +00:00
dir.c * dir.c (glob_make_pattern): fold continuous PLAINs to get rid of 2010-08-05 07:57:26 +00:00
dln.c * suppress warnings. 2010-05-21 09:10:23 +00:00
dln.h * configure.in (XCFLAGS): use -fvisibility=hidden if possible. 2010-07-21 21:38:25 +00:00
dln_find.c
dmydln.c
dmyencoding.c
dmyext.c
dmyversion.c
encoding.c * configure.in (XCFLAGS): use -fvisibility=hidden if possible. 2010-07-21 21:38:25 +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
file.c * file.c (realpath_rec): call rb_str_modify before rb_str_set_len. 2010-08-04 21:44:20 +00:00
gc.c * gc.c: don't call after_gc_sweep() after when garbage_collect() 2010-07-20 06:14:40 +00:00
gc.h * cont.c (stackgrowdirection): removed duplicated code, use 2010-05-08 16:15:20 +00:00
gem_prelude.rb Load gems properly. Fixes [ruby-core:31377] 2010-07-21 06:30:40 +00:00
golf_prelude.rb
goruby.c
hash.c * hash.c (rb_check_hash_type): added. 2010-08-03 12:01:13 +00:00
ia64.s
id.c * id.c (Init_id): add underscore name. 2010-06-20 07:17:46 +00:00
inits.c
insns.def * insns.def, vm_core.h: fixed typo. reported by Rocky Bernstein 2010-08-02 15:53:48 +00:00
io.c * io.c (io_flush_buffer): write and buffer operations should be 2010-07-20 03:50:41 +00:00
iseq.c * class.c, compile.c, dir.c, file.c, iseq.c, parse.y, random.c: 2010-07-27 07:13:43 +00:00
iseq.h * configure.in (XCFLAGS): use -fvisibility=hidden if possible. 2010-07-21 21:38:25 +00:00
lex.c.blt
load.c * ruby.c: add prototype of rb_realpath_internal. 2010-06-18 01:16:13 +00:00
main.c
marshal.c * marshal.c (w_float): should not append a dot if no fractal part 2010-08-05 09:25:39 +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
numeric.c * numeric.c (flo_cmp): typo. 2010-07-27 07:27:48 +00:00
object.c * object.c (rb_f_integer): add example with base. 2010-07-06 22:02:25 +00:00
pack.c * include/ruby/{intern,io}.h: add missing prototypes. 2010-07-22 03:02:40 +00:00
parse.y * parse.y (void_expr_gen): add 'possibly' to warning message. 2010-08-05 08:18:32 +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 * class.c, compile.c, dir.c, file.c, iseq.c, parse.y, random.c: 2010-07-27 07:13:43 +00:00
random.c * random.c (Init_Random): add Random::DEFAULT. 2010-08-03 12:16:06 +00:00
range.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
rational.c * complex.c (nucomp_marshal_load): should check the argument. 2010-08-05 09:36:16 +00:00
re.c * re.c (rb_reg_expr_str): fixed out-of-boundary access at invalid 2010-07-23 00:02:51 +00:00
regcomp.c
regenc.c
regenc.h * configure.in (XCFLAGS): use -fvisibility=hidden if possible. 2010-07-21 21:38:25 +00:00
regerror.c
regexec.c * regexec.c (onig_search): don't skip non-ANYCHARs when 2010-07-15 06:55:42 +00:00
regint.h * configure.in (XCFLAGS): use -fvisibility=hidden if possible. 2010-07-21 21:38:25 +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 * configure.in (XCFLAGS): use -fvisibility=hidden if possible. 2010-07-21 21:38:25 +00:00
regsyntax.c
ruby.c * ruby.c (ruby_init_loadpath_safe): ensure sopath to be modifiable 2010-08-05 05:12:50 +00:00
safe.c
signal.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
sprintf.c * sprintf.c: add short documentation about named reference. 2010-07-21 06:16:07 +00:00
st.c
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_set_len): bail out when buffer overflowed 2010-08-05 11:00:18 +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 (get_stack): fix memory leak; pthread_attr_destory 2010-07-22 11:15:16 +00:00
thread_pthread.h
thread_win32.c * thread_win32.c (native_thread_join): need to wait thread, of course. 2010-08-02 07:35:35 +00:00
thread_win32.h
time.c update doc. 2010-07-19 11:36:23 +00:00
timev.h
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 * configure.in (XCFLAGS): use -fvisibility=hidden if possible. 2010-07-21 21:38:25 +00:00
util.c * util.c (ruby_add_suffix): suppress a warning. 2010-07-31 00:36:12 +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 * 2010-08-06 2010-08-05 20:53:59 +00:00
vm.c * vm.c (rb_thread_mark): should mark iseq itself other than normal 2010-07-26 04:01:38 +00:00
vm_core.h * insns.def, vm_core.h: fixed typo. reported by Rocky Bernstein 2010-08-02 15:53:48 +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.h * class.c, compile.c, dir.c, file.c, iseq.c, parse.y, random.c: 2010-07-27 07:13:43 +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_method.c * vm_method.c (rb_method_boundp): revert r28543, r28564. 2010-07-21 05:00:53 +00:00
vm_opts.h
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: