development fork of ruby/ruby
Перейти к файлу
akr 6ac9fea36f update doc.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@30535 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2011-01-13 11:58:20 +00:00
bcc32 * configure.in: read API version from include/ruby/version.h. 2010-08-24 01:11:14 +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_method.rb: fix last commit. 2010-09-21 16:56:59 +00:00
cygwin * cygwin/GNUmakefile.in (SCRIPTPROGRAMS): ignore backup files and etc. 2010-12-10 09:28:42 +00:00
defs removes the dtrace support. reverts r26239, r26238 and r26235. 2010-01-05 05:59:23 +00:00
doc Mention the command search path issue on Windows. Pointed out by 2010-09-22 04:13:03 +00:00
enc * enc/{emacs_mule,euc_jp}.c (code_to_mbc): suppress warnings. 2011-01-05 20:16:32 +00:00
ext * ext/readline/extconf.rb: new checks for RL_PROMPT_START_IGNORE 2011-01-12 07:26:15 +00:00
include * include/ruby/defines.h (CASEFOLD_FILESYSTEM): HFS+ is case 2011-01-10 13:46:47 +00:00
lib update comment. 2011-01-12 10:36:08 +00:00
man fix typos in man 2010-12-01 11:07:03 +00:00
misc * misc/rdoc-mode.el (rdoc-mode): show trailing whitespace. 2011-01-10 04:51:20 +00:00
missing * missing/langinfo.c (strncasecmp): get rid of redefinition. 2010-11-17 22:16:53 +00:00
sample * lib/optparse.rb (OptionParser::Officious): separate completion 2010-12-07 13:31:11 +00:00
spec * ext/mkext.rb: remove purelib, fixes a bug in r28440, r28441. 2010-08-03 05:48:05 +00:00
symbian Added HAVE_LABS and HAVE_LLABS to config.h 2010-11-13 19:26:55 +00:00
template * template/id.h.tmpl: suppress all warning: "SUPPORT_JOKE" is not 2010-12-12 11:49:32 +00:00
test Simple fix for emacs parsing. (emacs doesn't like _heredocs_) 2011-01-12 21:53:31 +00:00
tool * tool/mkconfig.rb (RbConfig): get rid of unused variable. 2010-12-17 09:35:42 +00:00
win32 * win32/win32.c (rb_w32_write_console): don't raise exception when 2010-12-31 19:26:30 +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: ignore pkg-config metadata file. 2010-10-26 03:44:56 +00:00
.indent.pro * .indent.pro: added for ruby-style. 2010-03-11 21:50:56 +00:00
BSDL Add BSDL file. 2010-09-15 15:40:52 +00:00
COPYING * COPYING: change Ruby's License from a dual license with GPLv2 2010-09-15 15:35:31 +00:00
COPYING.ja * COPYING: change Ruby's License from a dual license with GPLv2 2010-09-15 15:35:31 +00:00
ChangeLog * vm_insnhelper.c: parenthesize macro arguments. 2011-01-13 11:49:54 +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 Revert r29271 pending due discussion. 2010-09-16 13:20:11 +00:00
Makefile.in * Makefile.in: remove unnecessary semicolons. 2010-12-30 18:03:13 +00:00
NEWS * NEWS (optparse): shell completion support. 2011-01-01 02:03:59 +00:00
README * README: update. 2010-05-06 03:12:28 +00:00
README.EXT * class.c (rb_scan_args): Add support for optional keyword 2010-09-10 07:51:58 +00:00
README.EXT.ja * README.EXT.ja (rb_ensure): typo. 2011-01-12 06:54:09 +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
addr2line.c * addr2line.c (get_nth_dirname): decrement the directory index 2011-01-12 15:35:07 +00:00
addr2line.h * addr2line.c: added to show source filename and line number of 2010-11-26 03:28:50 +00:00
array.c fix typos 2011-01-11 06:34:14 +00:00
bignum.c * bignum.c (bigmul1_karatsuba): avoid overflow that make assertion 2011-01-07 00:17:06 +00:00
class.c * class.c (make_metaclass): fix probable typo. builtin type flag 2010-12-05 08:56:42 +00:00
common.mk * common.mk (showflags): show LD commands. 2011-01-10 12:34:15 +00:00
compar.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
compile.c * compile.c (setup_args), vm.c (invoke_block_from_c), 2010-12-20 21:10:24 +00:00
complex.c update doc. 2011-01-08 10:51:14 +00:00
configure.in * io.c (Kernel.#syscall): implemented on LP64/LLP64 environments too. 2011-01-09 07:39:22 +00:00
constant.h remove a comma at end of enumerator list. 2010-12-10 02:42:06 +00:00
cont.c * cont.c: parenthesize macro arguments. 2010-12-06 20:56:04 +00:00
debug.c * debug.c: parenthesize macro arguments. 2010-12-07 12:16:10 +00:00
debug.h * debug.c (ruby_set_debug_option): define always for binary 2010-10-13 02:04:10 +00:00
dir.c update doc. 2011-01-13 11:58:20 +00:00
dln.c * dln.c (init_funcname_len): ignore rest from first dot. 2011-01-05 20:03:28 +00:00
dln.h * configure.in (XCFLAGS): use -fvisibility=hidden if possible. 2010-07-21 21:38:25 +00:00
dln_find.c * dln_find.c: parenthesize macro arguments. 2010-12-10 13:34:08 +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: parenthesize macro arguments. 2010-12-11 00:28:25 +00:00
enum.c * enum.c (sort_by_i): reenter check more strictly. 2011-01-12 10:27:48 +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 Exception#to_s should actually call to_s. 2011-01-12 22:05:05 +00:00
eval.c * eval.c (ruby_cleanup): fix type. 2010-12-02 21:45:49 +00:00
eval_error.c * eval_error.c: parenthesize macro arguments. 2010-12-12 04:28:29 +00:00
eval_intern.h * eval_intern.h (CHECK_STACK_OVERFLOW): it was not intended to add 2010-11-15 14:57:18 +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 (file_expand_path): get rid of warnings caused by 2010-12-26 13:24:17 +00:00
gc.c * vm.c (thread_free): reset ruby_current_thread if it points the 2011-01-12 10:35:36 +00:00
gc.h * gc.h (rb_objspace_each_objects): used in objspace. 2010-08-14 06:11:03 +00:00
gem_prelude.rb Tue Aug 17 07:38:43 2010 Nobuyoshi Nakada <nobu@ruby-lang.org> 2010-08-16 22:38:46 +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 (hash_i): return different values for inverse hash. 2011-01-11 23:37:15 +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 * compile.c (new_child_iseq): adjust argument types. 2010-10-31 13:11:02 +00:00
io.c * io.c (rb_f_syscall): Add warning messages. [ruby-core:34062] 2011-01-12 14:22:39 +00:00
iseq.c * iseq.c: parenthesize macro arguments. 2010-12-16 22:05:58 +00:00
iseq.h * compile.c (iseq_compile_each): fix for __goto__ and __label__ 2010-12-12 14:45:30 +00:00
lex.c.blt * defs/keywords (reserved_word): made inline function static. 2009-05-16 00:30:16 +00:00
load.c * include/ruby/defines.h (CASEFOLD_FILESYSTEM): HFS+ is case 2011-01-10 13:46:47 +00:00
main.c * main.c: <stdlib.h> is needed, to introduce the getenv(3) 2010-11-01 12:43:59 +00:00
marshal.c * marshal.c: parenthesize macro arguments. 2010-12-19 10:15:57 +00:00
math.c * math.c (math_atan2): you should know that M_PI is not the feature 2010-08-27 06:29:47 +00:00
method.h * class.c, constant.h, gc.c, method.h, object.c, variable.c, 2010-10-26 17:27:32 +00:00
node.c * node.c: parenthesize macro arguments. 2010-12-20 14:13:12 +00:00
node.h * node.h (RNode): match the type of flags to RBasic, and renamed 2010-12-15 23:04:50 +00:00
numeric.c * numeric.c (Init_Numeric): fixed a potential bug when using bccwin32 2010-12-01 13:05:17 +00:00
object.c * object.c: Make BasicObject.new accept no parameter. 2010-10-30 01:25:41 +00:00
pack.c * pack.c (swapf): compilation condition simplified. 2011-01-08 12:25:03 +00:00
parse.y * re.c (rb_reg_expr_str): need to escape if the coderage is invalid. 2010-12-28 09:43:49 +00:00
prelude.rb Fix :nodoc: definition. [ruby-dev:40949] 2010-04-10 22:09:09 +00:00
proc.c * transcode.c (transcode_loop): call default handler of the given 2010-12-07 13:05:26 +00:00
process.c update doc. 2010-12-29 01:33:28 +00:00
random.c * random.c (random_rand): suppress a warning. 2011-01-05 20:17:36 +00:00
range.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
rational.c * rational.c: parenthesize macro arguments. 2010-12-26 00:36:08 +00:00
re.c Sorry, commit miss of r30412. 2010-12-29 09:24:37 +00:00
regcomp.c * regcomp.c (setup_tree): restart setup_tree() for a node whose 2010-11-26 03:28:48 +00:00
regenc.c Clean a warning. 2010-11-09 10:14:47 +00:00
regenc.h * configure.in (XCFLAGS): use -fvisibility=hidden if possible. 2010-07-21 21:38:25 +00:00
regerror.c * removed spaces just before tabs. 2009-11-26 05:25:08 +00:00
regexec.c * regcomp.c (print_distance_range): use PRIuSIZE. 2010-11-25 14:14:44 +00:00
regint.h * regint.h (OnigOpInfoType): constify name. 2010-11-17 06:21:11 +00:00
regparse.c * regparse.c (and_cclass, or_cclass): fix memory leak. Coverity Scan 2010-11-15 16:06:35 +00:00
regparse.h * configure.in (XCFLAGS): use -fvisibility=hidden if possible. 2010-07-21 21:38:25 +00:00
regsyntax.c stripped trailing spaces. 2009-02-22 14:23:33 +00:00
ruby.c * ruby.c: parenthesize macro arguments. 2010-12-27 22:37:59 +00:00
safe.c fixed very important banners. 2010-11-23 14:36:37 +00:00
signal.c * signal.c: parenthesize macro arguments. 2010-12-29 01:07:26 +00:00
sprintf.c * sprintf.c: parenthesize macro arguments. 2010-12-30 02:50:34 +00:00
st.c * st.c: parenthesize macro arguments. 2010-12-31 01:28:41 +00:00
strftime.c * strftime.c: parenthesize macro arguments. 2011-01-01 02:45:04 +00:00
string.c fix spaces. 2011-01-08 13:07:20 +00:00
struct.c * array.c, gc.c, hash.c, object.c, string.c, struct.c, 2010-10-24 08:14:05 +00:00
thread.c * thread.c: parenthesize macro arguments. 2011-01-08 10:29:15 +00:00
thread_pthread.c * thread.c (thread_cleanup_func): Moved interrupted_lock 2010-12-20 15:20:17 +00:00
thread_pthread.h * thread.c, vm_core.h: make gvl_acquire/release/init/destruct 2010-11-27 20:15:59 +00:00
thread_win32.c * thread.c (thread_cleanup_func): Moved interrupted_lock 2010-12-20 15:20:17 +00:00
thread_win32.h * thread.c, vm_core.h: make gvl_acquire/release/init/destruct 2010-11-27 20:15:59 +00:00
time.c * time.c: parenthesize macro arguments. 2010-11-27 10:12:48 +00:00
timev.h * timev.h (TIME_SCALE): defined as 1000000000. 2009-08-29 19:06:29 +00:00
transcode.c * transcode.c: parenthesize macro arguments. 2011-01-09 11:38:55 +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: parenthesize macro arguments. 2011-01-10 02:24:04 +00:00
variable.c * variable.c: parenthesize macro arguments. 2011-01-11 11:33:53 +00:00
version.c * configure.in (SITE_DIR, VENDOR_DIR), 2010-11-22 21:30:54 +00:00
version.h * 2011-01-13 2011-01-12 15:35:08 +00:00
vm.c * vm.c (thread_free): reset ruby_current_thread if it points the 2011-01-12 10:35:36 +00:00
vm_core.h * compile.c (setup_args), vm.c (invoke_block_from_c), 2010-12-20 21:10:24 +00:00
vm_dump.c * vm_dump.c: delete dashes to make lines 80 chars, Patched by 2011-01-13 04:37:25 +00:00
vm_eval.c * vm_eval.c (rb_funcall): ensure va_end after va_init_list. Coverity 2010-11-15 13:48:37 +00:00
vm_exec.c * vm_exec.c (vm_exec_core): Treat clang as non gcc on this 2010-10-07 00:48:03 +00:00
vm_exec.h * configure.in (RUBY_CHECK_PRINTF_PREFIX): check for printf format 2010-10-12 15:03:51 +00:00
vm_insnhelper.c * vm_insnhelper.c: parenthesize macro arguments. 2011-01-13 11:49:54 +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_clear_cache_by_class): just return if the class has 2010-11-02 22:37:08 +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 (BSD__uqtoa): Fix overflow when long != quad_t. 2010-12-30 18:53:41 +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: