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 becd789625 * ext/curses/curses.c: Clean up documentation.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@32145 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2011-06-17 04:10: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 cancel subversion backfire. sorry 2011-03-07 08:44:45 +00:00
bootstraptest * bootstraptest/runner.rb (show_progress): refine verbose mode. 2011-06-14 14:17:42 +00:00
cygwin * cygwin/GNUmakefile.in (SCRIPTPROGRAMS): ignore backup files and etc. 2010-12-10 09:28:42 +00:00
defs
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/curses/curses.c: Clean up documentation. 2011-06-17 04:10:37 +00:00
include * fix for build on solaris 10. 2011-06-16 00:12:55 +00:00
lib * lib/csv.rb: Document #raw_encoding. Patch by David Czarnecki. 2011-06-16 22:54:53 +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 * test/testunit/test_parallel.rb: Fix Regexp for test. 2011-06-16 11:24:23 +00:00
tool * tool/rbinstall.rb (gem): fix for rubygems change. 2011-06-01 06:40:55 +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
.gdbinit
.gitignore remove duplicated and change comment location 2011-03-19 00:25:01 +00:00
.indent.pro
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 * array.c (rb_ary_drop): Improve documentation. Patch by Caley Woods. 2011-06-16 22:23:25 +00:00
atomic.h * atomic.h (ATOMIC_OR): _InterlockedOr is not available on migw. 2011-06-12 00:32:32 +00:00
bignum.c * bignum.c (bigmul1_toom3): remove unused variable. 2011-05-29 15:49:07 +00:00
BSDL Add BSDL file. 2010-09-15 15:40:52 +00:00
ChangeLog * ext/curses/curses.c: Clean up documentation. 2011-06-17 04:10:37 +00:00
class.c clone_const_i 2011-06-04 03:49:50 +00:00
common.mk * common.mk (sudo-precheck): authenticate at first to sudo. 2011-06-14 04:09:43 +00:00
compar.c
compile.c * prevent temporary objects from GC, and should not use 2011-02-20 07:23:55 +00:00
complex.c * complex.c (string_to_c_internal): uses rb_reg_nth_match; 2011-06-09 15:36:13 +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 * fix for build on solaris 10. 2011-06-16 00:12:55 +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 * 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.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_locale_charmap): When ruby process is run as Windows 2011-06-10 07:42:24 +00:00
enum.c * remove trailing spaces. 2011-05-15 11:55:52 +00:00
enumerator.c More clarification for enumerator_feed 2011-06-01 21:16:05 +00:00
error.c * prevent temporary objects from GC, and should not use 2011-02-20 07:23:55 +00:00
eval.c * eval.c: remove rb_thread_stop_timer_thread function declaration. 2011-06-05 14:35:09 +00:00
eval_error.c * eval_error.c: parenthesize macro arguments. 2010-12-12 04:28:29 +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 * fix for build on solaris 10. 2011-06-16 00:12:55 +00:00
gc.c * thread.c (rb_thread_schedule_rec): fix {UN,}LIKELY macro misuse. 2011-06-16 14:42:02 +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 (key_i): Change rdoc from "the first occurence" to "an 2011-05-31 22:35:59 +00:00
ia64.s
id.c
inits.c
insns.def Fix mixed declarations in r31822. 2011-05-30 07:28:30 +00:00
internal.h * io.c: fix IO.copy_stream interrupt handling. 2011-06-09 15:02:46 +00:00
io.c * io.c: Improve documentation of IO and File open and new. 2011-06-16 23:50:30 +00:00
iseq.c * iseq.c (prepare_iseq_build): initialize iseq_compile_data::err_info 2011-02-17 15:08:36 +00:00
iseq.h * compile.c (iseq_compile_each): fix for __goto__ and __label__ 2010-12-12 14:45:30 +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 * load.c (loaded_feature_path): cut nonsence loop execution to fix 2011-05-31 21:56:01 +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: add for internal use only. 2011-05-18 13:41:54 +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 (rb_mix_module): implement Module#mix. 2011-05-31 16:16:06 +00:00
NEWS * NEWS: introduce PKey.read 2011-06-12 20:52:25 +00:00
node.c * node.c (add_id): remove duplicated rb_id2str() call. 2011-01-31 14:29:49 +00:00
node.h * node.h: parenthesize macro arguments. 2011-01-20 14:59:59 +00:00
numeric.c * numeric.c (rb_enc_uint_chr): fix message format. Bug#4869 2011-06-11 07:52:34 +00:00
object.c * object.c: Document Module#method_added and #method_removed. 2011-06-17 00:11:20 +00:00
pack.c * remove trailing spaces. 2011-05-15 11:55:52 +00:00
parse.y * parse.y (parser_parse_string): flush delayed token. based on a 2011-06-13 14:38:26 +00:00
prelude.rb * remove trailing spaces. 2011-05-15 11:55:52 +00:00
proc.c * proc.c: Rdoc formatting, clarification & example fix 2011-05-27 13:55:43 +00:00
process.c * eval.c: remove rb_thread_stop_timer_thread function declaration. 2011-06-05 14:35:09 +00:00
random.c * remove trailing spaces. 2011-05-15 11:55:52 +00:00
range.c
rational.c * complex.c (string_to_c_internal): uses rb_reg_nth_match; 2011-06-09 15:36:13 +00:00
re.c * re.c (rb_reg_match): fix rdoc of Regexp#=~. 2011-05-29 14:18:34 +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 Clean a warning. 2010-11-09 10:14:47 +00:00
regenc.h
regerror.c
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 * ruby.c (ruby_process_options): add missing return type. 2011-06-11 01:01:09 +00:00
safe.c fixed very important banners. 2010-11-23 14:36:37 +00:00
signal.c * vm_core.h (RUBY_VM_SET_TIMER_INTERRUPT, RUBY_VM_SET_INTERRUPT, 2011-06-11 14:27:08 +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 * string.c: Fix the ambiguous description of the behavior of 2011-06-09 09:39:47 +00:00
struct.c * internal.h: add for internal use only. 2011-05-18 13:41:54 +00:00
thread.c * thread.c (rb_thread_schedule_rec): fix {UN,}LIKELY macro misuse. 2011-06-16 14:42:02 +00:00
thread_pthread.c * thread_pthread.c, thread_pthread.h: remove unused variables. 2011-06-16 19:52:54 +00:00
thread_pthread.h * thread_pthread.c, thread_pthread.h: remove unused variables. 2011-06-16 19:52:54 +00:00
thread_win32.c * thread.c (do_select): Windows: no need to poll if select(2) is 2011-06-15 18:04:13 +00:00
thread_win32.h fix win32 native_cond_timedwait() makes SIGSEGV. 2011-05-07 06:17:59 +00:00
time.c * time.c (rb_time_new): prevent overflow by "* 1000". 2011-06-16 19:46:08 +00:00
timev.h
ToDo
transcode.c * transcode.c (econv_init): revert r31353. [ruby-dev:43512] 2011-05-15 12:04:32 +00:00
transcode_data.h
util.c * util.c: parenthesize macro arguments. 2011-01-10 02:24:04 +00:00
variable.c * variable.c (const_missing): Add simple example of const_missing. 2011-06-16 06:17:59 +00:00
version.c * configure.in (SITE_DIR, VENDOR_DIR), 2010-11-22 21:30:54 +00:00
version.h * 2011-06-17 2011-06-16 17:28:58 +00:00
vm.c * vm_core.h, vm_insnhelper.h: move decl. of 2011-06-13 11:25:44 +00:00
vm_core.h * thread_pthread.c: rewrite GVL completely. 2011-06-13 14:14:53 +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 cancel subversion backfire. sorry 2011-03-07 08:44:45 +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 * thread.c (rb_thread_schedule_rec): fix {UN,}LIKELY macro misuse. 2011-06-16 14:42:02 +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_core.h, vm_insnhelper.h: move decl. of 2011-06-13 11:25:44 +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: