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 61ebfd3a34 * lib/yaml/dbm.rb: Add documentation. Patch by Justin Collins.
[Ruby 1.9 - Bug #4693]
	* lib/yaml/store.rb:  ditto


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@31559 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2011-05-14 00:50:39 +00:00
bcc32
benchmark * benchmark/bm_vm4_pipe.rb: Reduced iterations. Too slow benchmark 2011-05-04 13:14:28 +00:00
bin
bootstraptest
cygwin
defs
doc
enc * enc/trans/emoji_iso2022_kddi.trans: ISO-2022-JP-KDDI doesn't have 2011-04-27 02:45:36 +00:00
ext * ext/psych/lib/psych.rb: released a new gem, so increasing version. 2011-05-13 22:31:15 +00:00
include * thread.c (rb_fd_init): remove volatile qualifier. 2011-05-07 13:40:56 +00:00
lib * lib/yaml/dbm.rb: Add documentation. Patch by Justin Collins. 2011-05-14 00:50:39 +00:00
man
misc * misc/ruby-mode.el (ruby-parse-partial): use position of open paren. 2011-04-19 15:02:16 +00:00
missing
sample
spec
symbian
template
test * lib/rdoc.rb: Updated to RDoc 3.6 2011-05-14 00:39:16 +00:00
tool
win32 * win32/win32.c (rb_w32_select): check invalid handle before doing 2011-05-13 06:24:36 +00:00
.document
.gdbinit
.gitignore
.indent.pro
addr2line.c
addr2line.h
array.c * array.c (rb_ary_sort_bang): fix rdoc. 2011-04-22 03:05:32 +00:00
bignum.c * bignum.c (rb_str_to_inum): get rid of too huge alloca(). 2011-01-27 12:58:44 +00:00
BSDL
ChangeLog * lib/yaml/dbm.rb: Add documentation. Patch by Justin Collins. 2011-05-14 00:50:39 +00:00
class.c
common.mk Use UTF-8 for rdoc-coverage and silence progress reporter 2011-05-10 03:03:19 +00:00
compar.c
compile.c
complex.c * complex.c (string_to_c_internal): a refactoring. 2011-05-09 11:31:26 +00:00
configure.in * configure.in: limit to "T" type for prefix of external symbols 2011-05-12 09:31:34 +00:00
constant.h
cont.c
COPYING
COPYING.ja
debug.c
debug.h
dir.c * win32/{win32.c,dir.h} (rb_w32_uopendir): new API to pass UTF-8 path. 2011-04-28 07:22:18 +00:00
dln.c
dln.h
dln_find.c
dmydln.c
dmyencoding.c
dmyext.c
dmyversion.c
encoding.c * encoding.c (enc_find): accept Encoding objects. 2011-04-26 16:17:01 +00:00
enum.c
enumerator.c
error.c
eval.c * eval.c (frame_func_id): store result of method_entry_of_iseq() to 2011-05-05 08:39:22 +00:00
eval_error.c
eval_intern.h
eval_jump.c
file.c * file.c (rb_file_truncate): fix function. 2011-04-26 15:51:04 +00:00
gc.c
gc.h
gem_prelude.rb
golf_prelude.rb
goruby.c
GPL
hash.c
ia64.s
id.c
inits.c
insns.def
io.c * io.c (select_internal): remove unused variable (interrupt_flag). 2011-05-12 17:16:21 +00:00
iseq.c
iseq.h
KNOWNBUGS.rb
LEGAL
lex.c.blt
load.c
main.c
Makefile.in
marshal.c
math.c
method.h
NEWS * lib/rdoc.rb: Updated to RDoc 3.6 2011-05-14 00:39:16 +00:00
node.c
node.h
numeric.c * numeric.c (flo_coerce): fix a typo in documentation. 2011-05-13 12:38:49 +00:00
object.c * object.c: format comments to keep 80 columns in a line. 2011-05-12 12:18:47 +00:00
pack.c update doc. 2011-05-06 18:14:25 +00:00
parse.y
prelude.rb
proc.c
process.c * re.c (Init_Regexp): Document option constants. Patch by Vincent 2011-05-12 20:39:11 +00:00
random.c * random.c (random_rand): remove unused variables. 2011-04-25 07:56:42 +00:00
range.c
rational.c * complex.c, rational.c: omitted some method calls. 2011-04-24 13:24:02 +00:00
re.c * re.c (Init_Regexp): Document option constants. Patch by Vincent 2011-05-12 20:39:11 +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
regenc.c
regenc.h
regerror.c
regexec.c
regint.h
regparse.c
regparse.h
regsyntax.c
ruby.c * ruby.c (proc_options): reduce warning: "ALLOW_DEFAULT_SOURCE_ENCODING" is not defined. 2011-04-15 14:42:36 +00:00
safe.c
signal.c
sprintf.c * random.c (random_rand): remove unused variables. 2011-04-25 07:56:42 +00:00
st.c
strftime.c * random.c (random_rand): remove unused variables. 2011-04-25 07:56:42 +00:00
string.c * string.c: Improve documentation for String#start_with? and 2011-05-09 09:35:27 +00:00
struct.c * random.c (random_rand): remove unused variables. 2011-04-25 07:56:42 +00:00
thread.c * thread.c (rb_fd_zero): remove redundant zero fill. 2011-05-07 13:44:27 +00:00
thread_pthread.c * thread_pthread.c (native_cond_timedwait): add to care EINTR. 2011-05-08 10:46:27 +00:00
thread_pthread.h * thread_pthread.c (USE_MONOTONIC_COND): check the availability 2011-05-07 09:28:43 +00:00
thread_win32.c remove debugging code 2011-05-07 06:22:39 +00:00
thread_win32.h fix win32 native_cond_timedwait() makes SIGSEGV. 2011-05-07 06:17:59 +00:00
time.c * random.c (random_rand): remove unused variables. 2011-04-25 07:56:42 +00:00
timev.h
ToDo
transcode.c * transcode.c (econv_opts): add newline option. 2011-04-26 15:55:58 +00:00
transcode_data.h
util.c
variable.c
version.c
version.h * 2011-05-14 2011-05-13 17:52:05 +00:00
vm.c * vm.c (Init_VM): suppress warning: "OPT_BASIC_OPERATIONS" is not defined. 2011-04-16 01:23:34 +00:00
vm_core.h
vm_dump.c
vm_eval.c
vm_exec.c * include/ruby/intern.h: pcc can't use __builtin_constant_p. 2011-04-23 17:34:58 +00:00
vm_exec.h
vm_insnhelper.c
vm_insnhelper.h
vm_method.c * vm_method.c (rb_clear_cache_by_class): Revert r29673. It made 2011-04-29 01:29:22 +00:00
vm_opts.h
vsnprintf.c

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