1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
The Ruby Programming Language [mirror]
Find a file
drbrain 89b601d176 * lib/rdoc: Update to RDoc 3.9. Fixed ri [], stopdoc creating an
object reference, nodoc for class aliases, verbatim === lines.


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@32767 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2011-07-31 00:19:00 +00:00
bcc32
benchmark * benchmark/driver.rb: Add difference column to report that averages 2011-07-06 21:47:56 +00:00
bin * lib/rdoc: Update to RDoc 3.9. Fixed ri [], stopdoc creating an 2011-07-31 00:19:00 +00:00
bootstraptest * vm_insnhelper.c (vm_throw): check a class frame. 2011-07-10 09:04:44 +00:00
cygwin * cygwin/GNUmakefile.in (SCRIPTPROGRAMS): ignore backup files and etc. 2010-12-10 09:28:42 +00:00
defs * defs/default_gems: separate from tool/rbinstall.rb. 2011-07-30 14:19:11 +00:00
doc fix a typo 2011-07-14 07:56:22 +00:00
enc * enc/depend: show srcdir. 2011-06-16 00:10:10 +00:00
ext * ext/bigdecimal/bigdecimal.c (BigDecimal_version): version 1.1.0. 2011-07-30 05:31:45 +00:00
include See __APPLE__ for __syscall. 2011-07-28 00:23:28 +00:00
lib * lib/rdoc: Update to RDoc 3.9. Fixed ri [], stopdoc creating an 2011-07-31 00:19:00 +00:00
man fix typos in man 2010-12-01 11:07:03 +00:00
misc * misc/ruby-mode.el (ruby-indent-beg-re): Fix broken regular 2011-06-30 14:54:11 +00:00
missing * missing/lgamma_r.c (lgamma_r): get rid of false warning on mingw. 2011-05-18 13:35:13 +00:00
sample * remove trailing spaces. 2011-05-15 11:55:52 +00:00
spec * spec/README: update the description. 2011-05-24 22:13:14 +00:00
symbian
template * template/fake.rb.in (CROSS_COMPILING): get rid of NameError. 2011-02-11 02:39:05 +00:00
test * lib/rdoc: Update to RDoc 3.9. Fixed ri [], stopdoc creating an 2011-07-31 00:19:00 +00:00
tool * defs/default_gems: separate from tool/rbinstall.rb. 2011-07-30 14:19:11 +00:00
win32 * win32/win32.c (is_socket, is_console): add prototypes to fix compile 2011-07-15 18:22:42 +00:00
.document
.gdbinit
.gitignore remove duplicated and change comment location 2011-03-19 00:25:01 +00:00
.indent.pro
addr2line.c * addr2line.c: use USE_ELF instead of __ELF__ because Solaris 2011-07-08 12:23:10 +00:00
addr2line.h * addr2line.c: use USE_ELF instead of __ELF__ because Solaris 2011-07-08 12:23:10 +00:00
array.c * array.c (rb_ary_set_len): new function to set array length. 2011-07-29 14:53:51 +00:00
atomic.h * atomic.h (ATOMIC_OR): _InterlockedOr is unavailable in VC6. 2011-07-09 07:56:04 +00:00
bignum.c * bignum.c (bigsub_int): add RB_GC_GUARD. This patch is made by 2011-07-15 10:16:41 +00:00
BSDL
ChangeLog * lib/rdoc: Update to RDoc 3.9. Fixed ri [], stopdoc creating an 2011-07-31 00:19:00 +00:00
class.c * class.c (Init_class_hierarchy): should name BasicObject 2011-06-30 18:34:09 +00:00
common.mk * common.mk (RUN_OPT): disable gems. 2011-07-08 23:39:42 +00:00
compar.c
compile.c * compile.c (when_vals): when a string literal is written on when 2011-07-10 03:11:52 +00:00
complex.c * internal.h: added declarations. 2011-07-09 10:50:51 +00:00
configure.in * configure.in (enable_pthread): use -pthread on OpenBSD without 2011-07-29 07:17:32 +00:00
constant.h * constant.h, variable.c: to ensure compatibility, rb_const_get_* must 2011-01-28 17:57:27 +00:00
cont.c * cont.c (cont_save_thread): fix missing semicolon. 2011-07-19 07:39:54 +00:00
COPYING
COPYING.ja
debug.c * debug.c: parenthesize macro arguments. 2010-12-07 12:16:10 +00:00
debug.h * debug.h: parenthesize macro arguments. 2011-01-17 13:54:54 +00:00
dir.c * dir.c: Make RDoc more precise about order of Dir.glob 2011-06-27 23:38:31 +00:00
dln.c * dln.c (init_funcname_len): ignore rest from first dot. 2011-01-05 20:03:28 +00:00
dln.h
dln_find.c * dln_find.c (dln_find_1): use rb_warning and return immediately 2011-01-26 23:22:54 +00:00
dmydln.c
dmyencoding.c
dmyext.c
dmyversion.c
encoding.c * encoding.c (rb_enc_set_index, rb_enc_associate_index): should 2011-07-07 06:44:46 +00:00
enum.c * enum.c (enum_inject): remove empty line to notify rdoc 2011-07-21 09:12:36 +00:00
enumerator.c * enumerator.c: Remove "enumeration sequenced by". 2011-07-09 00:25:27 +00:00
error.c * error.c (rb_name_error_str): new function to raise NameError 2011-07-23 15:05:03 +00:00
eval.c * thread_pthread.c (rb_thread_create_timer_thread): removed 2011-07-10 17:04:40 +00:00
eval_error.c * eval_error.c (rb_print_undef_str): new function to raise 2011-07-26 16:05:35 +00:00
eval_intern.h * eval_error.c (rb_print_undef_str): new function to raise 2011-07-26 16:05:35 +00:00
eval_jump.c cancel subversion backfire. sorry 2011-03-07 08:44:45 +00:00
file.c * include/ruby/intern.h (rb_update_max_fd): declaration moved from 2011-07-20 13:26:10 +00:00
gc.c * proc.c (struct METHOD), gc.c (gc_marks), vm_method.c 2011-07-25 14:29:28 +00:00
gc.h * eval.c (ruby_cleanup): use rb_ary_free to free internal object. 2011-02-11 10:45:34 +00:00
gem_prelude.rb * ruby.c (process_options): revert r30549. 2011-01-17 12:40:30 +00:00
golf_prelude.rb cancel subversion backfire. sorry 2011-03-07 08:44:45 +00:00
goruby.c
GPL
hash.c * hash.c: Document ENV 2011-06-30 00:20:15 +00:00
ia64.s
id.c
inits.c * internal.h: declare internal functions here. 2011-06-17 22:43:38 +00:00
insns.def * insns.def: written in Shift_JIS. 2011-07-04 06:52:39 +00:00
internal.h * array.c (rb_ary_set_len): new function to set array length. 2011-07-29 14:53:51 +00:00
io.c * io.c (rb_io_each_byte): remove unused variable e. 2011-07-30 16:31:36 +00:00
iseq.c * method.h, internal.h iseq.h: declare internal functions. 2011-06-18 03:49:33 +00:00
iseq.h * method.h, internal.h iseq.h: declare internal functions. 2011-06-18 03:49:33 +00:00
KNOWNBUGS.rb
LEGAL * LEGAL (missing/{elf,tgamma,lgamma_r}.c): they've been replaced by 2011-05-17 11:11:57 +00:00
lex.c.blt
load.c * eval_error.c (rb_print_undef_str): new function to raise 2011-07-26 16:05:35 +00:00
main.c
Makefile.in * common.mk (RUN_OPT): disable gems. 2011-07-08 23:39:42 +00:00
marshal.c * internal.h: declare internal functions here. 2011-06-17 22:43:38 +00:00
math.c * math.c: Attach documentation for Math. 2011-06-29 03:09:34 +00:00
method.h * method.h, internal.h iseq.h: declare internal functions. 2011-06-18 03:49:33 +00:00
NEWS * NEWS: mention Kernel#warn. [ruby-core:38119] [Feature #5029] 2011-07-19 22:17:13 +00:00
node.c * node.c (dump_node): add today's knowledge. "init arguments (m)" and 2011-07-21 10:35:52 +00:00
node.h * internal.h: declare internal functions here. 2011-06-17 22:43:38 +00:00
numeric.c * numeric.c (rb_num2ull): use FIX2LONG instead of FIX2ULONG. see 2011-07-11 06:03:41 +00:00
object.c * object.c: Add usage documentation for BasicObject. Based on patch 2011-07-27 06:44:39 +00:00
pack.c * remove trailing spaces. 2011-05-15 11:55:52 +00:00
parse.y * parse.y (rb_check_id): make the given name a symbol or a string. 2011-07-26 16:05:27 +00:00
prelude.rb * remove trailing spaces. 2011-05-15 11:55:52 +00:00
proc.c * eval_error.c (rb_print_undef_str): new function to raise 2011-07-26 16:05:35 +00:00
process.c * include/ruby/intern.h (rb_update_max_fd): declaration moved from 2011-07-20 13:26:10 +00:00
random.c * include/ruby/intern.h (rb_update_max_fd): declaration moved from 2011-07-20 13:26:10 +00:00
range.c * range.c (range_max): fix behavior with excluded end value. 2011-07-10 00:47:31 +00:00
rational.c * internal.h: declare internal functions here. 2011-06-17 22:43:38 +00:00
re.c * internal.h: declare internal functions here. 2011-06-17 22:43:38 +00:00
README
README.EXT * README.EXT: fix typo. Patch by William Blackerby. 2011-05-13 09:59:16 +00:00
README.EXT.ja * README.EXT: fix typo. Patch by William Blackerby. 2011-05-13 09:59:16 +00:00
README.ja
regcomp.c Show encoding of compiling regexp. 2011-02-23 00:04:51 +00:00
regenc.c
regenc.h
regerror.c
regexec.c Fix type of arguments in debug prints. 2011-02-23 00:04:55 +00:00
regint.h * regint.h (PLATFORM_UNALIGNED_WORD_ACCESS): Power PC does not 2011-07-14 16:51:29 +00:00
regparse.c * addr2line.c: suppressed shorten-64-to-32 warnings. 2011-01-31 03:44:57 +00:00
regparse.h * addr2line.c: suppressed shorten-64-to-32 warnings. 2011-01-31 03:44:57 +00:00
regsyntax.c
ruby.c * include/ruby/intern.h (rb_update_max_fd): declaration moved from 2011-07-20 13:26:10 +00:00
safe.c fixed very important banners. 2010-11-23 14:36:37 +00:00
signal.c * vm.c (th_init): preallocate alternative stack. 2011-07-30 01:57:06 +00:00
sprintf.c * random.c (random_rand): remove unused variables. 2011-04-25 07:56:42 +00:00
st.c * regint.h (PLATFORM_UNALIGNED_WORD_ACCESS): Power PC does not 2011-07-14 16:51:29 +00:00
strftime.c * strftime.c (NEEDS): avoid SEGV due to integer overflow in sparc-solaris2.10 2011-07-30 13:41:45 +00:00
string.c * string.c (tr_trans): free heap ptr when the str is not embeded. 2011-07-01 05:28:48 +00:00
struct.c * error.c (rb_check_trusted): new function to check an object is 2011-07-17 07:26:45 +00:00
thread.c * thread.c (set_trace_func, thread_set_trace_func_m): reset tracing 2011-07-21 11:09:52 +00:00
thread_pthread.c * io.c (rb_update_max_fd): new function. 2011-07-19 07:10:19 +00:00
thread_pthread.h * thread_pthread.h (rb_global_vm_lock_struct): add volatile to 2011-06-27 12:59:08 +00:00
thread_win32.c * include/ruby/intern.h, thread_pthread.c (rb_reserved_fd_p, 2011-07-03 21:56:59 +00:00
thread_win32.h fix win32 native_cond_timedwait() makes SIGSEGV. 2011-05-07 06:17:59 +00:00
time.c * error.c (rb_check_trusted): new function to check an object is 2011-07-17 07:26:45 +00:00
timev.h
ToDo
transcode.c * internal.h: declare internal functions here. 2011-06-17 22:43:38 +00:00
transcode_data.h
util.c * thread_pthread.c (mutex_debug): use exit(EXIT_FAILURE) instad of 2011-07-10 08:29:46 +00:00
variable.c * eval_error.c (rb_print_undef_str): new function to raise 2011-07-26 16:05:35 +00:00
version.c * math.c: Attach documentation for Math. 2011-06-29 03:09:34 +00:00
version.h * 2011-07-31 2011-07-30 16:24:38 +00:00
vm.c * vm.c (th_init): preallocate alternative stack. 2011-07-30 01:57:06 +00:00
vm_core.h * vm_core.h (ALT_STACK_SIZE): use MINSIGSTKSZ*2 instead of SIGSTKSZ*2. 2011-07-30 02:22:51 +00:00
vm_dump.c * vm_dump.c (VMDEBUG): suppress undefined macro warnings. 2011-07-27 02:04:51 +00:00
vm_eval.c * array.c (rb_ary_set_len): new function to set array length. 2011-07-29 14:53:51 +00:00
vm_exec.c * vm_exec.c: remove conditions for clang 2011-05-31 02:08:58 +00:00
vm_exec.h * vm_exec.h: parenthesize macro arguments. 2011-01-23 02:39:44 +00:00
vm_insnhelper.c * vm_insnhelper.c (vm_call_cfunc): added volatile for a workaround 2011-07-22 12:52:25 +00:00
vm_insnhelper.h * vm_core.h, vm_insnhelper.h: move decl. of 2011-06-13 11:25:44 +00:00
vm_method.c * vm_method.c (rb_gc_mark_unlinked_live_method_entries): remove unused 2011-07-26 16:17:24 +00:00
vm_opts.h
vsnprintf.c * vsnprintf.c (cvt): set first byte of buf to NUL for the case when 2011-01-18 17:56:10 +00:00

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