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
marcandre 3f5e567a47 * random.c: Documentation fix for Random#bytes
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@32255 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2011-06-27 15:42:37 +00:00
bcc32 * configure.in: read API version from include/ruby/version.h. 2010-08-24 01:11:14 +00:00
benchmark * benchmark/bm_vm4_thread_create_join.rb, 2011-06-16 18:09:03 +00:00
bin * lib/rake/version.rb: Fixed VERSION to work with tool/rbinstall.rb 2011-06-23 22:24:44 +00:00
bootstraptest * compile.c (iseq_compile_each): fix return value of obj[a,*b]=c. 2011-06-17 10:18:39 +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 * doc/irb/irb.rd: fix typo. patch by Nobuhiro IMAI. 2011-06-07 11:52:41 +00:00
enc * enc/depend: show srcdir. 2011-06-16 00:10:10 +00:00
ext * ext/date/date_parse.c: should use ALLOCA_N. 2011-06-26 23:01:56 +00:00
include * internal.h: move rb_thread_io_blocking_region() declaration 2011-06-21 12:31:17 +00:00
lib fix [Bug #4409]. add DRbServer#here? 2011-06-27 15:18:22 +00:00
man fix typos in man 2010-12-01 11:07:03 +00:00
misc * misc/ruby-mode.el (ruby-parse-partial): use position of open paren. 2011-04-19 15:02:16 +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 Added HAVE_LABS and HAVE_LLABS to config.h 2010-11-13 19:26:55 +00:00
template * template/fake.rb.in (CROSS_COMPILING): get rid of NameError. 2011-02-11 02:39:05 +00:00
test fix [Bug #4409]. add DRbServer#here? 2011-06-27 15:18:22 +00:00
tool * lib/rake/version.rb: Fixed VERSION to work with tool/rbinstall.rb 2011-06-23 22:24:44 +00:00
win32 * thread.c (do_select): Windows: no need to poll if select(2) is 2011-06-15 18:04:13 +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 remove duplicated and change comment location 2011-03-19 00:25:01 +00:00
.indent.pro * .indent.pro: added for ruby-style. 2010-03-11 21:50:56 +00:00
addr2line.c * addr2line.c (uleb128): cast the value to unsigned long. 2011-03-02 16:14:32 +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 * cont.c (cont_capture): add volatile. 2011-06-22 11:00:24 +00:00
atomic.h * atomic.h (ATOMIC_OR): _InterlockedOr is not available on migw. 2011-06-12 00:32:32 +00:00
bignum.c * internal.h: declare internal functions here. 2011-06-17 22:43:38 +00:00
BSDL Add BSDL file. 2010-09-15 15:40:52 +00:00
ChangeLog fix [Bug #4409]. add DRbServer#here? 2011-06-27 15:18:22 +00:00
class.c * internal.h: declare internal functions here. 2011-06-17 22:43:38 +00:00
common.mk * eval.c, hash.c, load.c, proc.c, range.c, thread.c, time.c: don't 2011-06-18 08:26:19 +00:00
compar.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
compile.c * method.h, internal.h iseq.h: declare internal functions. 2011-06-18 03:49:33 +00:00
complex.c * internal.h: declare internal functions here. 2011-06-17 22:43:38 +00:00
configure.in * configure.in, win32/Makefile.sub (RUBY_SO_NAME): add CPU as prefix 2011-05-16 02:22:27 +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_capture): add volatile. 2011-06-22 11:00:24 +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
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 * internal.h: declare internal functions here. 2011-06-17 22:43:38 +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 (dln_find_1): use rb_warning and return immediately 2011-01-26 23:22:54 +00:00
dmydln.c * dln_find.c: split from dln.c. 2010-02-24 00:55:03 +00:00
dmyencoding.c
dmyext.c
dmyversion.c * dmyversion.c: empty load path in miniruby. 2010-02-08 07:28:00 +00:00
encoding.c * internal.h: declare internal functions here. 2011-06-17 22:43:38 +00:00
enum.c * remove trailing spaces. 2011-05-15 11:55:52 +00:00
enumerator.c * internal.h: declare internal functions here. 2011-06-17 22:43:38 +00:00
error.c * internal.h: declare internal functions here. 2011-06-17 22:43:38 +00:00
eval.c * thread_pthread.c: Stop polling in the timer thread when there are 2011-06-27 00:30:41 +00:00
eval_error.c * internal.h: declare more internal functions. 2011-06-18 01:54:57 +00:00
eval_intern.h * fix for build on solaris 10. 2011-06-16 00:12:55 +00:00
eval_jump.c cancel subversion backfire. sorry 2011-03-07 08:44:45 +00:00
file.c * internal.h: declare internal functions here. 2011-06-17 22:43:38 +00:00
gc.c * internal.h: declare internal functions here. 2011-06-17 22:43:38 +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 (rb_hash_reject): add documentation that Hash#reject 2011-06-26 15:45:47 +00:00
ia64.s
id.c * id.c (Init_id): add underscore name. 2010-06-20 07:17:46 +00:00
inits.c * internal.h: declare internal functions here. 2011-06-17 22:43:38 +00:00
insns.def Fix mixed declarations in r31822. 2011-05-30 07:28:30 +00:00
internal.h * internal.h: move rb_thread_io_blocking_region() declaration 2011-06-21 12:31:17 +00:00
io.c * io.c (fill_cbuf): finish reading at EOF, and the readconv has 2011-06-18 15:00:00 +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 indented. 2010-02-20 03:17:44 +00:00
LEGAL * LEGAL (missing/{elf,tgamma,lgamma_r}.c): they've been replaced by 2011-05-17 11:11:57 +00:00
lex.c.blt * defs/keywords (reserved_word): made inline function static. 2009-05-16 00:30:16 +00:00
load.c * eval.c, hash.c, load.c, proc.c, range.c, thread.c, time.c: don't 2011-06-18 08:26:19 +00:00
main.c * main.c: <stdlib.h> is needed, to introduce the getenv(3) 2010-11-01 12:43:59 +00:00
Makefile.in * configure.in (rubygems): add --disable-rubygems option. 2011-02-11 03:03:26 +00:00
marshal.c * internal.h: declare internal functions here. 2011-06-17 22:43:38 +00:00
math.c * internal.h: declare internal functions here. 2011-06-17 22:43:38 +00:00
method.h * method.h, internal.h iseq.h: declare internal functions. 2011-06-18 03:49:33 +00:00
NEWS Add news about r30188 (Net::HTTPRequest#set_form). 2011-06-26 15:55:29 +00:00
node.c * node.c (add_id): remove duplicated rb_id2str() call. 2011-01-31 14:29:49 +00:00
node.h * internal.h: declare internal functions here. 2011-06-17 22:43:38 +00:00
numeric.c * internal.h: declare internal functions here. 2011-06-17 22:43:38 +00:00
object.c * method.h, internal.h iseq.h: declare internal functions. 2011-06-18 03:49:33 +00:00
pack.c * remove trailing spaces. 2011-05-15 11:55:52 +00:00
parse.y * parse.y (rb_parser_end_seen_p): fix documentation about return 2011-06-26 15:45:49 +00:00
prelude.rb * remove trailing spaces. 2011-05-15 11:55:52 +00:00
proc.c * eval.c, hash.c, load.c, proc.c, range.c, thread.c, time.c: don't 2011-06-18 08:26:19 +00:00
process.c * thread_pthread.c: Stop polling in the timer thread when there are 2011-06-27 00:30:41 +00:00
random.c * random.c: Documentation fix for Random#bytes 2011-06-27 15:42:37 +00:00
range.c * eval.c, hash.c, load.c, proc.c, range.c, thread.c, time.c: don't 2011-06-18 08:26:19 +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: update. 2010-05-06 03:12:28 +00:00
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 * README: update. 2010-05-06 03:12:28 +00:00
regcomp.c Show encoding of compiling regexp. 2011-02-23 00:04:51 +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 Fix type of arguments in debug prints. 2011-02-23 00:04:55 +00:00
regint.h * addr2line.c: suppressed shorten-64-to-32 warnings. 2011-01-31 03:44:57 +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 * internal.h: declare more internal functions. 2011-06-18 01:54:57 +00:00
safe.c fixed very important banners. 2010-11-23 14:36:37 +00:00
signal.c * thread_pthread.c: Stop polling in the timer thread when there are 2011-06-27 00:30:41 +00:00
sprintf.c * random.c (random_rand): remove unused variables. 2011-04-25 07:56:42 +00:00
st.c * st.c (st_foreach): check if unpacked. 2011-01-27 14:30:00 +00:00
strftime.c * strftime.c (rb_strftime_with_timespec): improved style consistency. 2011-05-31 03:59:36 +00:00
string.c * internal.h: declare internal functions here. 2011-06-17 22:43:38 +00:00
struct.c * internal.h: add for internal use only. 2011-05-18 13:41:54 +00:00
thread.c * thread_pthread.c: Stop polling in the timer thread when there are 2011-06-27 00:30:41 +00:00
thread_pthread.c * thread_pthread.c (consume_communication_pipe): don't use C99 2011-06-27 13:10:26 +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 * thread_pthread.c: Stop polling in the timer thread when there are 2011-06-27 00:30:41 +00:00
thread_win32.h fix win32 native_cond_timedwait() makes SIGSEGV. 2011-05-07 06:17:59 +00:00
time.c * eval.c, hash.c, load.c, proc.c, range.c, thread.c, time.c: don't 2011-06-18 08:26:19 +00:00
timev.h * timev.h (TIME_SCALE): defined as 1000000000. 2009-08-29 19:06:29 +00:00
ToDo
transcode.c * internal.h: declare internal functions here. 2011-06-17 22:43:38 +00:00
transcode_data.h * configure.in (XCFLAGS): use -fvisibility=hidden if possible. 2010-07-21 21:38:25 +00:00
util.c * internal.h: declare more internal functions. 2011-06-18 01:54:57 +00:00
variable.c * internal.h: declare internal functions here. 2011-06-17 22:43:38 +00:00
version.c * configure.in (SITE_DIR, VENDOR_DIR), 2010-11-22 21:30:54 +00:00
version.h * 2011-06-28 2011-06-27 15:10:32 +00:00
vm.c * vm.c, vm_core.h (rb_vm_stack_to_heap): remove const. 2011-06-18 12:32:57 +00:00
vm_core.h * thread_pthread.c: Stop polling in the timer thread when there are 2011-06-27 00:30:41 +00:00
vm_dump.c * vm_dump.c (rb_vm_bugreport): change CrashReporter suggestion messages 2011-06-26 04:49:33 +00:00
vm_eval.c * method.h, internal.h iseq.h: declare internal functions. 2011-06-18 03:49:33 +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_search_superclass): avoid control frame 2011-06-25 15:05:37 +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 * method.h, internal.h iseq.h: declare internal functions. 2011-06-18 03:49:33 +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: