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 c9118e2a86 hash.c: key name in error message
* hash.c (env_fetch): Add key name to message on ENV.fetch KeyError,
  as well as Hash#fetch.  [ruby-core:56062] [Feature #8649]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@42025 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2013-07-17 08:12:25 +00:00
benchmark * benchmark/gc/gcbench.rb: fix summary of benchmark result notaton. 2013-06-21 08:57:18 +00:00
bin
bootstraptest * bootstraptest/test_thread.rb: rescue resource limitation errors. 2013-06-23 06:41:37 +00:00
cygwin
defs Set mode for GNU Makefile. 2013-06-20 10:19:02 +00:00
doc * doc/syntax/refinements.rdoc: add description of Module#using and 2013-07-02 08:24:26 +00:00
enc Revert r41786 "broken utf-8" 2013-07-09 07:38:15 +00:00
ext * ext/bigdecimal/lib/bigdecimal/util.rb: [DOC] document top-level 2013-07-15 23:16:26 +00:00
include * include/ruby/st.h (st_strcasecmp): Macro defined for compatibility. 2013-07-17 03:31:44 +00:00
lib * lib/cgi/util.rb (CGI::Util#escape, unescape): Unuse regexp special 2013-07-16 23:52:47 +00:00
man * man/ri.1: Incorrect use of .Dd macro [Bug #8620] by Tristan Hill 2013-07-10 15:55:12 +00:00
misc
missing
nacl
sample fix typo by @daveworth [fix GH-340] 2013-06-25 08:49:36 +00:00
spec
symbian
template * template/encdb.h.tmpl: define encoding index macros to use the index 2013-07-01 14:12:10 +00:00
test hash.c: key name in error message 2013-07-17 08:12:25 +00:00
tool probes_to_wiki.rb: fix comment and reduce unnecessary array 2013-07-11 01:46:40 +00:00
win32 win32.c: fix infinite recursion 2013-07-11 12:30:24 +00:00
.document
.editorconfig
.gdbinit
.gitignore Ignore tool/config.guess and tool/config.sub 2013-06-16 07:10:20 +00:00
.indent.pro
.travis.yml update config files 2013-06-14 04:40:32 +00:00
addr2line.c
addr2line.h
array.c array.c: fix typo 2013-07-16 09:50:11 +00:00
bignum.c * bignum.c (bigmul1_toom3): Use bigdivrem_single instead of bigdivrem. 2013-07-16 15:17:21 +00:00
BSDL
ChangeLog hash.c: key name in error message 2013-07-17 08:12:25 +00:00
class.c * include/ruby/ruby.h, gc.c: rename macros and functions: 2013-06-22 21:54:10 +00:00
common.mk localeinit.c: split 2013-07-14 17:47:25 +00:00
compar.c
compile.c * compile.c (make_name_for_block): use PRIsVALUE in format string 2013-06-24 11:31:21 +00:00
complex.c
configure.in * configure.in: revert r42008. strcasecmp() uses the current locale. 2013-07-16 12:49:01 +00:00
constant.h * class.c, include/ruby/ruby.h: add write barriers for T_CLASS, 2013-06-14 09:23:54 +00:00
cont.c
COPYING
COPYING.ja
debug.c * safe.c (rb_set_safe_level, safe_setter): raise an ArgumentError 2013-06-12 14:20:51 +00:00
dir.c dir.c: get rid of FindFirstFile bug 2013-07-03 05:15:28 +00:00
dln.c
dln.h dln.c: extra arguments 2013-06-30 01:58:51 +00:00
dln_find.c dln.c: extra arguments 2013-06-30 01:58:51 +00:00
dmydln.c
dmyext.c
encoding.c encoding.c: revert r41964 2013-07-16 04:32:09 +00:00
enum.c internal.h: STATIC_ASSERT 2013-07-10 11:47:54 +00:00
enumerator.c enumerator.c: lazyenum_size 2013-06-28 04:26:21 +00:00
error.c error.c: evaluate RARRAY_AREF once 2013-06-20 04:14:09 +00:00
eval.c * eval.c (rb_using_module): activate refinements in the ancestors of 2013-07-01 03:57:16 +00:00
eval_error.c * eval_error.c (warn_printf): use rb_vsprintf instead so ruby specific 2013-06-24 13:03:35 +00:00
eval_intern.h
eval_jump.c
file.c * safe.c (rb_set_safe_level, safe_setter): raise an ArgumentError 2013-06-12 14:20:51 +00:00
gc.c * gc.c: catch up last changes for debugging/checking mode. 2013-07-17 07:01:19 +00:00
gc.h
gem_prelude.rb
golf_prelude.rb
goruby.c
GPL
hash.c hash.c: key name in error message 2013-07-17 08:12:25 +00:00
ia64.s
inits.c
insns.def * hash.c (rb_hash_tbl_raw), internal.h: added. 2013-05-26 16:19:04 +00:00
internal.h * proc.c (rb_block_arity): create internal API rb_block_arity(). 2013-07-15 04:26:58 +00:00
io.c * io.c (appendline): cosmetic change 2013-07-16 02:25:54 +00:00
iseq.c * include/ruby/ruby.h (OBJ_WRITE): cast to (VALUE *) for second 2013-06-21 19:52:40 +00:00
iseq.h * include/ruby/ruby.h (struct rb_data_type_struct), gc.c: add 2013-06-19 06:26:01 +00:00
KNOWNBUGS.rb
LEGAL
lex.c.blt
load.c load.c: suppress warning 2013-06-22 01:27:17 +00:00
loadpath.c * loadpath.c (RUBY_REVISION): Defined to suppress revision.h 2013-06-17 11:56:21 +00:00
localeinit.c localeinit.c: split 2013-07-14 17:47:25 +00:00
main.c
Makefile.in * Makefile.in (after-update): non-configure platforms don't need 2013-06-14 05:10:15 +00:00
marshal.c * bignum.c (MSB): Removed. 2013-06-25 03:08:23 +00:00
math.c * internal.h (numberof): Gathered from various files. 2013-06-07 10:01:19 +00:00
method.h * class.c, include/ruby/ruby.h: add write barriers for T_CLASS, 2013-06-14 09:23:54 +00:00
miniinit.c localeinit.c: split 2013-07-14 17:47:25 +00:00
NEWS * NEWS: Add REXML::Text#<< related updates. 2013-07-07 02:55:10 +00:00
node.c
node.h
numeric.c * numeric.c: [DOC] improve rdoc formatting for parameters and links 2013-07-15 18:27:23 +00:00
object.c * object.c (rb_obj_cmp): Improve doc for Kernel#<=> 2013-07-09 13:25:57 +00:00
pack.c * internal.h (ruby_digit36_to_number_table): Declared. 2013-07-03 13:32:14 +00:00
parse.y * compile.c (make_name_for_block): use PRIsVALUE in format string 2013-06-24 11:31:21 +00:00
prelude.rb
probes.d
probes_helper.h
proc.c * proc.c (rb_block_arity): raise ArgumentError if no block given. 2013-07-16 02:22:17 +00:00
process.c * process.c (rb_daemon): daemon(3) is implemented with fork(2). 2013-07-11 01:13:10 +00:00
random.c * safe.c (rb_set_safe_level, safe_setter): raise an ArgumentError 2013-06-12 14:20:51 +00:00
range.c intern.h: define rb_enumerator_size_func 2013-06-26 13:43:22 +00:00
rational.c * rational.c (numeric_quo): move num_quo in numeric.c to numeric_quo 2013-06-07 02:50:32 +00:00
re.c re.c: use built-in encoding indexes 2013-07-02 08:22:47 +00:00
README
README.EXT Add Appendix C containing a pointer to mkmf. 2013-06-12 08:48:01 +00:00
README.EXT.ja Elaborate on side-effects of mkmf functions. 2013-06-12 06:41:11 +00:00
README.ja Fix the mail address of Matz; ruby-lang.jp does not exist. 2013-06-11 08:01:38 +00:00
regcomp.c * regcomp.c (): Merge Onigmo 5.13.5 23b523076d6f1161. 2013-07-04 01:16:22 +00:00
regenc.c Revert r41786 "broken utf-8" 2013-07-09 07:38:15 +00:00
regenc.h
regerror.c
regexec.c
regint.h
regparse.c
regparse.h
regsyntax.c
ruby.c * compile.c (make_name_for_block): use PRIsVALUE in format string 2013-06-24 11:31:21 +00:00
ruby_atomic.h ruby_atomic.h: ATOMIC_CAS on VC6 2013-07-03 15:13:06 +00:00
safe.c ruby.h: safe_level check 2013-06-13 05:51:14 +00:00
signal.c signal.c: suppress a warning 2013-07-14 17:43:55 +00:00
siphash.c
siphash.h
sparc.c
sprintf.c * sprintf.c: Fix typo patch by @hynkle [Fixes GH-357] 2013-07-11 04:49:33 +00:00
st.c * st.c (st_locale_insensitive_strcasecmp): Renamed from st_strcasecmp. 2013-07-16 23:15:41 +00:00
strftime.c
string.c string.c: char length 2013-07-14 17:40:32 +00:00
struct.c * struct.c (rb_struct_each_pair): use rb_yield_values(2, key, value) 2013-07-15 05:20:11 +00:00
thread.c * thread.c (mutex_sleep): [DOC] Awake thread will reacquire lock 2013-07-15 01:56:52 +00:00
thread_pthread.c * internal.h (numberof): Gathered from various files. 2013-06-07 10:01:19 +00:00
thread_pthread.h
thread_win32.c win32: for strict ANSI 2013-07-08 14:12:26 +00:00
thread_win32.h
time.c Unused variable removed. 2013-06-11 16:37:37 +00:00
timev.h
transcode.c encoding.c: refill terminator at associating encoding 2013-07-12 07:28:40 +00:00
transcode_data.h
util.c * internal.h (ruby_digit36_to_number_table): Declared. 2013-07-03 13:32:14 +00:00
variable.c * include/ruby/ruby.h (OBJ_WRITE): cast to (VALUE *) for second 2013-06-21 19:52:40 +00:00
version.c
version.h * 2013-07-17 2013-07-16 15:17:26 +00:00
vm.c * include/ruby/ruby.h (OBJ_WRITE): cast to (VALUE *) for second 2013-06-21 19:52:40 +00:00
vm_backtrace.c * vm_backtrace.c: Update rdoc for Backtrace#label with @_ko1 2013-06-17 05:31:28 +00:00
vm_core.h * include/ruby/ruby.h (struct rb_data_type_struct), gc.c: add 2013-06-19 06:26:01 +00:00
vm_debug.h
vm_dump.c
vm_eval.c intern.h: define rb_enumerator_size_func 2013-06-26 13:43:22 +00:00
vm_exec.c
vm_exec.h
vm_insnhelper.c * vm_insnhelper.c (vm_call_method): ensure methods of type 2013-06-18 14:01:32 +00:00
vm_insnhelper.h
vm_method.c * class.c (rb_include_class_new), eval.c (rb_using_refinement): 2013-06-22 20:48:35 +00:00
vm_opts.h
vm_trace.c * safe.c (rb_set_safe_level, safe_setter): raise an ArgumentError 2013-06-12 14:20:51 +00:00
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://bugs.ruby-lang.org/projects/ruby-trunk/wiki/SupportedPlatforms


== How to get Ruby

For a complete list of ways to install Ruby, including using third party
tools like rvm, see:

http://www.ruby-lang.org/en/downloads/

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 the 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 the 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 <mailto:ruby-talk-ctl@ruby-lang.org>.


== How to compile and install

This is what you need to do to compile and install Ruby:

0.   If you want to use Microsoft Visual C++ to compile ruby,
     read win32/README.win32 instead of this document.

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 <tt>optflags=..</tt> and <tt>warnflags=..</tt> as
     necessary to override them.

3.   Edit +defines.h+ if you need. Usually this step will not be needed.

4.   Remove comment mark(<tt>#</tt>) 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 "<tt>#option nodynamic</tt>" in
     +ext/Setup+.

     Usually this step will not be needed.

5.   Run +make+.

6.   Optionally, run '<tt>make check</tt>' to check whether the compiled Ruby
     interpreter works well. If you see the message "<tt>check succeeded</tt>",
     your ruby works as it should (hopefully).

7.   Run '<tt>make install</tt>'

     This command will create following directories and install files
     onto them.

     * <tt>${DESTDIR}${prefix}/bin</tt>
     * <tt>${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}</tt>
     * <tt>${DESTDIR}${prefix}/include/ruby-${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}</tt>
     * <tt>${DESTDIR}${prefix}/lib</tt>
     * <tt>${DESTDIR}${prefix}/lib/ruby</tt>
     * <tt>${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}</tt>
     * <tt>${DESTDIR}${prefix}/lib/ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}</tt>
     * <tt>${DESTDIR}${prefix}/lib/ruby/site_ruby</tt>
     * <tt>${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}</tt>
     * <tt>${DESTDIR}${prefix}/lib/ruby/site_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}</tt>
     * <tt>${DESTDIR}${prefix}/lib/ruby/vendor_ruby</tt>
     * <tt>${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}</tt>
     * <tt>${DESTDIR}${prefix}/lib/ruby/vendor_ruby/${MAJOR}.${MINOR}.${TEENY}/${PLATFORM}</tt>
     * <tt>${DESTDIR}${prefix}/lib/ruby/gems/${MAJOR}.${MINOR}.${TEENY}</tt>
     * <tt>${DESTDIR}${prefix}/share/man/man1</tt>
     * <tt>${DESTDIR}${prefix}/share/ri/${MAJOR}.${MINOR}.${TEENY}/system</tt>

     If Ruby's API version is '_x.y.z_', the <tt>${MAJOR}</tt> is '_x_', the
     <tt>${MINOR}</tt> is '_y_', and the <tt>${TEENY}</tt> 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.

Some extension libraries may not get compiled because of lack of
necessary external libraries and/or headers, then you will need to run
'<tt>make distclean-ext</tt>' to remove old configuration after
installing them in such case.

== Copying

See the file +COPYING+.

== Feedback

Questions about the Ruby language can be asked on the Ruby-Talk mailing list
(http://www.ruby-lang.org/en/community/mailing-lists) or on websites like
(http://stackoverflow.com).

Bug reports should be filed at http://bugs.ruby-lang.org

== The Author

Ruby was originally designed and developed by Yukihiro Matsumoto (Matz) in 1995.

<mailto:matz@ruby-lang.org>

--
Local variables:
mode: rdoc
end: