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
nobu 14c97cf9b6 * ext/dl/extconf.rb: clang does not use -fno-defer-pop during compilation.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@34523 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2012-02-09 16:41:08 +00:00
bcc32
benchmark * benchmark/bm_io_select[23].rb: use Process::RLIMIT_NOFILE only when 2011-11-17 11:24:07 +00:00
bin * lib/rdoc: Update to RDoc 3.9. Fixed ri [], stopdoc creating an 2011-07-31 00:19:00 +00:00
bootstraptest * test/ruby/test_object.rb (test_send_with_block): moved from 2012-01-02 06:25:01 +00:00
cygwin
defs * tool/rbinstall.rb (gem): install all gemspecs under lib and ext. 2011-08-04 07:08:48 +00:00
doc * doc/re.rdoc (Repetition): fix typo. reported by Ori Avtalion 2012-02-01 00:50:17 +00:00
enc * numeric.c (rb_enc_uint_char): raise RangeError when added codepoint 2012-01-08 20:42:45 +00:00
ext * ext/dl/extconf.rb: clang does not use -fno-defer-pop during compilation. 2012-02-09 16:41:08 +00:00
include * string.c (rb_str_modify_expand): fix memory leak. 2012-02-08 13:30:04 +00:00
lib eliminate shadowing outer local variable - name warning. 2012-02-08 18:03:51 +00:00
man * README.ja: Update redmine.ruby-lang.org to bugs.ruby-lang.org 2011-12-19 21:07:09 +00:00
misc * misc/rdoc-mode.el (rdoc-imenu-create-index): Add imenu support 2012-01-22 15:56:03 +00:00
missing * missing/setproctitle.c (ruby_init_setproctitle): changed prefix. 2012-01-17 08:13:50 +00:00
sample * sample/drb/dhasenc.rb: coding cookie of Emacs is coding, 2011-09-09 16:44:38 +00:00
spec * spec/README: update the description. 2011-05-24 22:13:14 +00:00
symbian
template * template/Doxyfile.tmpl (INCLUDE_PATH): add srcdir and include. 2011-11-09 02:40:39 +00:00
test * test/ruby/envutil.rb (assert_no_memory_leak): new assertion to 2012-02-09 15:47:11 +00:00
tool * tool/merger.rb: don't abort, update first. 2012-02-08 01:04:07 +00:00
win32 * win32/win32.c (rb_w32_read): fix an issue that $stdin.read doesn't 2012-01-28 00:51:43 +00:00
.document
.gdbinit
.gitignore remove duplicated and change comment location 2011-03-19 00:25:01 +00:00
.indent.pro
.travis.yml * .travis.yml (script): should be ./configure 2011-11-26 06:41:29 +00:00
addr2line.c * addr2line.c (PATH_MAX): define if not defined. [ruby-core:40840] 2011-11-08 14:31:56 +00:00
addr2line.h * addr2line.c: use USE_ELF instead of __ELF__ because Solaris 2011-07-08 12:23:10 +00:00
array.c Fix typo 2012-01-05 02:52:10 +00:00
atomic.h * complex.c: use "__sun" instead of "__sun__" to detect SunOS. 2011-10-24 14:57:08 +00:00
bignum.c * bignum.c (big_rshift), compile.c (validate_label, 2011-12-05 09:57:00 +00:00
BSDL
ChangeLog * ext/dl/dl.h (ALIGN_OF): use offsetof(). 2012-02-09 16:30:43 +00:00
class.c * gc.c: use Bitmap Marking algorithm to avoid copy-on-write of 2012-01-07 14:02:23 +00:00
common.mk * common.mk (test-ruby): pass TESTS for options. 2012-01-27 07:35:13 +00:00
compar.c
compile.c * compile.c (iseq_set_sequence): adjust indent. 2012-01-14 13:16:29 +00:00
complex.c * complex.c (nucomp_rationalize): fix function. [ruby-core:40667] 2011-11-02 12:36:06 +00:00
configure.in * configure.in (HEAP_ALIGN_LOG): HEAP_ALIGN_LOG should be page 2012-01-31 12:36:50 +00:00
constant.h * variable.c (rb_const_set): show the previous definition 2011-09-03 15:11:53 +00:00
cont.c * cont.c (cont_restore_0): prevent optimizing out `sp'. sp is used for 2012-01-12 05:12:03 +00:00
COPYING
COPYING.ja Change encoding from EUC-JP to UTF-8. [Feature #5128] 2011-09-04 12:22:46 +00:00
debug.c * gc.c: use Bitmap Marking algorithm to avoid copy-on-write of 2012-01-07 14:02:23 +00:00
debug.h
dir.c * file.c (rb_enc_path_next, rb_enc_path_skip_prefix) 2012-01-25 02:32:06 +00:00
dln.c * include/ruby/defines.h: use "__sparc" instead of "sparc" and 2011-10-25 12:54:21 +00:00
dln.h
dln_find.c * gc.c (rb_objspace_free): global_List is allocated with xmalloc. 2012-01-08 21:02:08 +00:00
dmydln.c
dmyencoding.c
dmyext.c
dmyversion.c
encoding.c * encoding.c (rb_enc_compatible): return ASCII-8BIT even if 2nd string 2012-02-05 15:17:50 +00:00
enum.c update doc. 2012-02-09 13:18:26 +00:00
enumerator.c * use RB_TYPE_P which is optimized for constant types, instead of 2011-09-29 11:07:45 +00:00
error.c * error.c (exc_inspect): Fix typo. patch from Trent Ogren 2012-02-07 11:13:40 +00:00
eval.c * eval.c: Improve rdoc for Module.constants [issue #5887] 2012-01-12 16:37:03 +00:00
eval_error.c * use RB_TYPE_P which is optimized for constant types, instead of 2011-09-29 11:07:45 +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 * file.c (append_fspath): need to set the encoding to result always. 2012-01-30 03:31:58 +00:00
gc.c * configure.in (HEAP_ALIGN_LOG): HEAP_ALIGN_LOG should be page 2012-01-31 12:36:50 +00:00
gc.h
gem_prelude.rb
golf_prelude.rb cancel subversion backfire. sorry 2011-03-07 08:44:45 +00:00
goruby.c * goruby.c: windows support. 2011-12-21 07:03:06 +00:00
GPL
hash.c * whitespace cleanup. 2011-11-04 07:19:23 +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 (pop): suppress self-assign warning of clang. 2011-11-27 08:24:19 +00:00
internal.h * gc.c (ruby_mimmalloc): defined for objects need not rb_objspace, 2012-01-10 03:49:10 +00:00
io.c * io.c (argf_next_argv): reset ARGF.next_p on ARGV.replace. 2012-02-02 08:52:55 +00:00
iseq.c * iseq.c (iseq_data_to_ary): check line info table boundary. line 2012-01-14 12:56:46 +00:00
iseq.h * iseq.h, iseq.c, compile.c: Change the line number data structure 2011-08-24 06:31:15 +00:00
KNOWNBUGS.rb
LEGAL * util.c, include/ruby/util.h (ruby_add_suffix): remove the function. 2011-08-03 07:10:56 +00:00
lex.c.blt
load.c * load.c (load_unlock): update loading table at once. 2012-01-13 08:23:43 +00:00
main.c
Makefile.in * common.mk,Makefile.in,win32/Makefile.sub (ECHO1): move platform 2011-12-14 11:02:00 +00:00
marshal.c * use RB_TYPE_P which is optimized for constant types, instead of 2011-09-29 11:07:45 +00:00
math.c * complex.c: use "__sun" instead of "__sun__" to detect SunOS. 2011-10-24 14:57:08 +00:00
method.h * method.h, internal.h iseq.h: declare internal functions. 2011-06-18 03:49:33 +00:00
NEWS * lib/shellwords.rb (Shellwords#shellescape): shellescape() now 2012-01-12 18:49:30 +00:00
node.c * node.h (rb_args_info): change pre_args_num and post_args_num as 2011-12-27 12:17:36 +00:00
node.h * gc.c: use Bitmap Marking algorithm to avoid copy-on-write of 2012-01-07 14:02:23 +00:00
numeric.c * numeric.c (rb_enc_uint_char): raise RangeError when added codepoint 2012-01-08 20:42:45 +00:00
object.c * object.c (rb_Hash): fix mixed declaration and code. 2012-01-24 07:21:33 +00:00
pack.c * class.c (rb_obj_methods), compile.c (iseq_compile_each), 2011-12-05 09:50:12 +00:00
parse.y * parse.y (debug_lines, coverage): set file path encoding for coverage 2012-02-01 16:28:14 +00:00
prelude.rb * remove trailing spaces. 2011-05-15 11:55:52 +00:00
proc.c * proc.c (proc_call): get rid of optimazation-out by clang. 2011-12-24 03:38:56 +00:00
process.c * gc.c (rb_objspace_free): global_List is allocated with xmalloc. 2012-01-08 21:02:08 +00:00
random.c * process.c (ruby_setsid): use rb_cloexec_open. 2011-10-29 04:01:54 +00:00
range.c * range.c: Improve documentation for Range. Patch by Chris Zetter. 2011-12-05 23:36:53 +00:00
rational.c * use RB_TYPE_P which is optimized for constant types, instead of 2011-09-29 11:07:45 +00:00
re.c * gc.c (rb_objspace_free): global_List is allocated with xmalloc. 2012-01-08 21:02:08 +00:00
README * README: add comment for Git user. patch from Arun Agrawal. 2012-01-03 11:48:20 +00:00
README.EXT * README.EXT, README.EXT.ja: rb_iter_break() and rb_iter_break_value(). 2012-01-24 06:28:26 +00:00
README.EXT.ja * README.EXT, README.EXT.ja: rb_iter_break() and rb_iter_break_value(). 2012-01-24 06:28:26 +00:00
README.ja * README: add comment for Git user. patch from Arun Agrawal. 2012-01-03 11:48:20 +00:00
regcomp.c * regcomp.c (onig_region_memsize): implemented for memsize_of(). 2011-12-15 04:15:54 +00:00
regenc.c * numeric.c (rb_enc_uint_char): raise RangeError when added codepoint 2012-01-08 20:42:45 +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 * regcomp.c (onig_region_memsize): implemented for memsize_of(). 2011-12-15 04:15:54 +00:00
regparse.c * regparse.c: fix typo. 2011-12-05 10:12:02 +00:00
regparse.h
regsyntax.c
ruby.c * missing/setproctitle.c (ruby_init_setproctitle): changed prefix. 2012-01-17 08:13:50 +00:00
safe.c * use RB_TYPE_P which is optimized for constant types, instead of 2011-09-29 11:07:45 +00:00
signal.c * bignum.c (big_rshift), compile.c (validate_label, 2011-12-05 09:57:00 +00:00
sparc.c * README.ja: Update redmine.ruby-lang.org to bugs.ruby-lang.org 2011-12-19 21:07:09 +00:00
sprintf.c * sprintf.c (rb_enc_vsprintf): relaxed the restriction. since the 2012-01-14 03:02:57 +00:00
st.c * st.c: refactor packed entries using structs. 2012-02-07 10:37:40 +00:00
strftime.c * strftime.c (rb_strftime_with_timespec): get enc argument to specify 2011-08-27 09:18:18 +00:00
string.c * string.c (rb_str_modify_expand): fix memory leak. 2012-02-08 13:30:04 +00:00
struct.c * use RB_TYPE_P which is optimized for constant types, instead of 2011-09-29 11:07:45 +00:00
thread.c * thread.c (rb_mutex_unlock_th): simplified. 2012-01-13 09:29:13 +00:00
thread_pthread.c * thread_pthread.c (ping_signal_thread_list): remove return value. 2011-12-22 13:45:58 +00:00
thread_pthread.h * thread_pthread.h: no Structured Exception Handling like macros. 2011-10-29 00:05:11 +00:00
thread_win32.c * thread_win32.c (rb_w32_wait_events_blocking): use 2012-01-28 00:51:36 +00:00
thread_win32.h fix win32 native_cond_timedwait() makes SIGSEGV. 2011-05-07 06:17:59 +00:00
time.c update doc. 2011-11-19 10:48:22 +00:00
timev.h
transcode.c * transcode.c (str_encode): about the extension of :fallback 2011-12-14 06:28:32 +00:00
transcode_data.h
util.c * ext/bigdecimal/bigdecimal.h: add satisfy cc-mode comment. 2011-12-22 21:06:19 +00:00
variable.c * variable.c (set_const_visibility): clear inine-cache when constant's 2011-12-08 14:47:19 +00:00
version.c * math.c: Attach documentation for Math. 2011-06-29 03:09:34 +00:00
version.h * 2012-02-10 2012-02-09 15:16:04 +00:00
vm.c * vm.c (rb_iter_break_value): new function to break a block with 2012-01-24 05:20:48 +00:00
vm_core.h * vm_core.h: Fix comment about arg_opts of iseq and some typos 2011-12-30 05:55:37 +00:00
vm_dump.c * io.c (rb_write_error2): get rid of warning on linux. fwrite 2011-11-27 12:06:10 +00:00
vm_eval.c * vm_eval.c (vm_call0): should pass block to enumerators. patched 2012-01-30 10:08:23 +00:00
vm_exec.c * vm_exec.c: remove conditions for clang 2011-05-31 02:08:58 +00:00
vm_exec.h
vm_insnhelper.c * vm_eval.c (vm_call0): should pass block to enumerators. patched 2012-01-30 10:08:23 +00:00
vm_insnhelper.h fix typos 2011-10-06 11:51:55 +00:00
vm_method.c * variable.c (set_const_visibility): print a warning when no argument 2011-12-03 11:52:14 +00:00
vm_opts.h
vsnprintf.c * vsnprintf.c (BSD_vfprintf): support 'll' prefix. 2011-11-01 04:31:52 +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://bugs.ruby-lang.org/projects/ruby-trunk/wiki/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

Or if you are using git then use following command:

  $ git clone git://github.com/ruby/ruby.git

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/

Or if you are using git then use following command:

  $ git ls-remote git://github.com/ruby/ruby.git

* 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 check' to check whether the compiled Ruby
     interpreter works well.  If you see the message "check 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: