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 6da33430de string.c: empty string is not invalid
* string.c (rb_enc_cr_str_copy_for_substr): empty string is always
  valid or 7bit.


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@38617 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2012-12-25 22:31:26 +00:00
bcc32
benchmark * common.mk: specify label `built-ruby'. 2012-11-26 09:30:32 +00:00
bin * lib/rdoc*: Updated to RDoc 4.0 (pre-release) 2012-11-27 04:28:14 +00:00
bootstraptest * vm.c (rb_vm_make_env_object): make Proc object if Env is possible 2012-11-27 11:58:10 +00:00
cygwin * cygwin/GNUmakefile.in (uncommon.mk): link *.res.o. 2012-11-05 14:00:35 +00:00
defs id.h.tmpl: ID2ATTRSET 2012-12-21 07:38:11 +00:00
doc * lib/rake/*: Updated to rake 0.9.6 2012-12-21 02:34:37 +00:00
enc * enc/depend (link_so): prefix $(Q) for each commands. 2012-12-10 04:32:11 +00:00
ext zlib.c: function name 2012-12-23 06:21:49 +00:00
include * bignum.c, include/ruby/intern.h (rb_big_eql): exported. 2012-12-25 10:14:12 +00:00
lib * remove trailing spaces. 2012-12-25 18:10:46 +00:00
man * man/erb.1: Fix grammar and copyright dates 2012-11-15 04:22:44 +00:00
misc Fix a typo in misc/ruby-additional.el. 2012-12-03 06:52:47 +00:00
missing setproctitle.c: _NSGetEnviron 2012-06-20 07:36:23 +00:00
nacl * nacl/GNUmakefile.in (.rbconfig.time): r36828 was incomplete. 2012-08-28 02:34:43 +00:00
sample test.rb: show messages in one line 2012-12-11 18:09:10 +00:00
spec * spec/default.mspec: expand relative path for ruby_exe which uses 2012-04-16 09:23:50 +00:00
symbian
template id.h.tmpl: ID2ATTRSET 2012-12-21 07:38:11 +00:00
test test_rubyoptions.rb: ARGF 2012-12-25 22:29:42 +00:00
tool * vm_core.h, eval_intern.h (CHECK_STACK_OVERFLOW): move 2012-12-25 09:57:07 +00:00
win32 * win32/{dir.h,win32.c} (rb_w32_readdir): removed old rb_w32_readdir() 2012-12-21 13:06:17 +00:00
.document * common.mk: Added --pages-dir to rdoc creation. Now doc/ items show 2012-12-11 07:57:56 +00:00
.editorconfig .editorconfig: new 2012-09-15 23:16:15 +00:00
.gdbinit .gdbinit: FLONUM support 2012-09-06 05:49:51 +00:00
.gitignore id.c: generate 2012-12-04 17:36:19 +00:00
.indent.pro
.travis.yml * .travis.yml (script): add OPTS=-v, requested by @_ko1. 2012-11-19 06:41:43 +00:00
addr2line.c * vm_dump.c (rb_vm_bugreport): revert r38533. 2012-12-21 17:21:12 +00:00
addr2line.h
array.c * array.c, enum.c, insns.def, io.c, numeric.c, parse.y, process.c, 2012-12-02 09:57:47 +00:00
bignum.c * bignum.c, include/ruby/intern.h (rb_big_eql): exported. 2012-12-25 10:14:12 +00:00
BSDL
ChangeLog string.c: empty string is not invalid 2012-12-25 22:31:26 +00:00
class.c * class.c (rewrite_cref_stack, clone_method): rewrite a method's cref 2012-12-17 09:49:00 +00:00
common.mk common.mk: srcs-ext 2012-12-22 16:53:12 +00:00
compar.c
compile.c scoped constant op-assignment 2012-12-24 15:59:31 +00:00
complex.c complex.c, time.c: make marshal methods private 2012-12-01 09:17:02 +00:00
configure.in * configure.in (NULLCMD): check in loop. 2012-12-15 01:39:49 +00:00
constant.h
cont.c * thread.c: rename methods: 2012-12-23 10:18:58 +00:00
COPYING
COPYING.ja
debug.c * include/ruby/debug.h: introdudced. 2012-11-20 12:57:49 +00:00
dir.c * win32/{dir.h,win32.c} (rb_w32_readdir): removed old rb_w32_readdir() 2012-12-21 13:06:17 +00:00
dln.c adjust style. 2012-12-01 15:25:28 +00:00
dln.h
dln_find.c
dmydln.c * encoding.c (rb_enc_codepoint_len): Use UNREACHABLE to avoid "control 2012-04-13 23:45:37 +00:00
dmyencoding.c
dmyext.c no K&R style 2012-05-19 03:36:39 +00:00
dmyversion.c
encoding.c adjust style. 2012-12-01 15:25:28 +00:00
enum.c * array.c, enum.c, insns.def, io.c, numeric.c, parse.y, process.c, 2012-12-02 09:57:47 +00:00
enumerator.c adjust style. 2012-12-01 15:25:28 +00:00
error.c error.c: rb_write_error_str 2012-12-25 04:38:18 +00:00
eval.c * eval.c (rb_using_refinement): make the method table of an iclass 2012-12-11 16:48:21 +00:00
eval_error.c internal.h: quote unprintable 2012-12-22 15:04:57 +00:00
eval_intern.h * vm_core.h, eval_intern.h (CHECK_STACK_OVERFLOW): move 2012-12-25 09:57:07 +00:00
eval_jump.c volatile errinfo 2012-03-18 15:21:00 +00:00
file.c * file.c (rb_file_flock): use rb_thread_wait_for() instead of 2012-12-14 18:08:40 +00:00
gc.c * gc.c (obj_id_to_ref): add a macro to treat Bignum object id. 2012-12-22 04:25:18 +00:00
gc.h * gc.h (SET_MACHINE_STACK_END): add volatile for preventing 2012-12-01 21:15:01 +00:00
gem_prelude.rb
golf_prelude.rb
goruby.c goruby.c: IRB at end 2012-12-23 06:34:56 +00:00
GPL * GPL: update text of GPLv2. [ruby-core:44488] [Bug #6328] 2012-06-03 13:07:58 +00:00
hash.c adjust style. 2012-12-01 15:25:28 +00:00
ia64.s * removed trailing spaces. 2012-06-09 21:36:05 +00:00
inits.c * vm_trace.c: separate trace_func related functions from 2012-08-15 04:39:10 +00:00
insns.def * vm_core.h (rb_vm_defineclass_type_t), 2012-12-20 08:13:53 +00:00
internal.h error.c: rb_write_error_str 2012-12-25 04:38:18 +00:00
io.c error.c: rb_write_error_str 2012-12-25 04:38:18 +00:00
iseq.c * iseq.c (Init_ISeq): remove definition of the following methods: 2012-12-21 11:44:09 +00:00
iseq.h compile.c, vm_insnhelper.c: flip-flop without hidden string key 2012-12-10 06:11:16 +00:00
KNOWNBUGS.rb vm_trace.c: exceptions in event hooks 2012-12-10 06:23:44 +00:00
LEGAL
lex.c.blt
load.c error.c: rb_write_error_str 2012-12-25 04:38:18 +00:00
main.c * include/ruby/debug.h: introdudced. 2012-11-20 12:57:49 +00:00
Makefile.in * Makefile.in (LIBRUBY_SO): sign also. 2012-12-10 05:05:32 +00:00
marshal.c marshal.c: rb_check_funcall_with_hook 2012-12-23 06:05:50 +00:00
math.c * include/ruby/util.h: removed extra semicolon in definition of 2012-11-21 12:42:11 +00:00
method.h * method.h: remove `VM_METHOD_TYPE_CFUNC_FRAMELESS' method type. 2012-12-17 22:04:12 +00:00
NEWS Deprecate #{lines,bytes,chars,codepoints} of IO-likes. 2012-12-22 17:22:04 +00:00
node.c * include/ruby/util.h: removed extra semicolon in definition of 2012-11-21 12:42:11 +00:00
node.h scoped constant op-assignment 2012-12-24 15:59:31 +00:00
numeric.c * include/ruby/intern.h: add the prototype declaration of 2012-12-22 15:06:22 +00:00
object.c internal.h: quote unprintable 2012-12-22 15:04:57 +00:00
pack.c set encoding to ASCII for appropriate String#unpack modifiers 2012-10-19 13:13:32 +00:00
parse.y scoped constant op-assignment 2012-12-24 15:59:31 +00:00
prelude.rb * prelude.rb: Moved Mutex#synchronize to 2012-11-19 10:22:53 +00:00
probes.d * variable.c (rb_class_path_no_cache): add a function to get the class 2012-12-01 02:13:06 +00:00
probes_helper.h probes_helper.h: RUBY_DTRACE_HOOK 2012-12-11 03:37:19 +00:00
proc.c internal.h: quote unprintable 2012-12-22 15:04:57 +00:00
process.c * thread.c: rename methods: 2012-12-23 10:18:58 +00:00
random.c random.c, rational.c: make marshal methods private 2012-12-03 10:10:14 +00:00
range.c * array.c, enum.c, insns.def, io.c, numeric.c, parse.y, process.c, 2012-12-02 09:57:47 +00:00
rational.c * rational.c (f_round_common): should check overflow. 2012-12-15 09:25:13 +00:00
re.c * re.c (rb_reg_eqq): doc: #=== is not a synonym for #=~, added example 2012-12-23 05:52:50 +00:00
README * README: mention about README.win32. 2012-11-26 16:01:51 +00:00
README.EXT * README.EXT: Converted to RDoc format 2012-12-03 23:34:17 +00:00
README.EXT.ja * README.EXT: Converted to RDoc format 2012-12-03 23:34:17 +00:00
README.ja inilne markups 2012-05-03 15:09:41 +00:00
regcomp.c Remove unused variables. 2012-03-05 07:40:51 +00:00
regenc.c
regenc.h
regerror.c * regcomp.c: Merge Onigmo 3d855b30d574536d3ae600260208c6624ae4791c. 2012-03-21 10:53:06 +00:00
regexec.c * regcomp.c: Merge Onigmo 3d855b30d574536d3ae600260208c6624ae4791c. 2012-03-21 10:53:06 +00:00
regint.h * regint.h (BITS_IN_ROOM, BS_ROOM, BS_BIT): suppress warnings. 2012-03-22 09:37:44 +00:00
regparse.c * regparse.c (parse_char_class): should match with a hyphen after a 2012-10-13 14:23:40 +00:00
regparse.h
regsyntax.c
ruby.c * ruby.c (process_options): need to acquire env from TOPLEVEL_BINDING 2012-12-21 10:39:59 +00:00
ruby_atomic.h * ruby_atomic.h (ATOMIC_CAS): added for Solaris and other platforms. 2012-11-27 10:21:59 +00:00
safe.c
signal.c * thread.c: rename methods: 2012-12-23 10:18:58 +00:00
siphash.c siphash.c: union sip_init_state 2012-11-09 14:02:31 +00:00
siphash.h * siphash.h: check configure macros before include newer headers. 2012-11-09 15:34:31 +00:00
sparc.c adjust style. 2012-06-27 05:37:15 +00:00
sprintf.c sprintf.c: infect 2012-08-15 07:26:55 +00:00
st.c st_update passes the key in st_table 2012-11-17 02:46:13 +00:00
strftime.c unecessary macros and K&R style coding 2012-08-16 00:46:12 +00:00
string.c string.c: empty string is not invalid 2012-12-25 22:31:26 +00:00
struct.c * struct.c (make_struct): remove junk ID check to allow members who 2012-12-22 02:52:48 +00:00
thread.c * ChangeLog: revert a part of r38595. 'iff' means 'if and only if', not typo. 2012-12-25 10:45:20 +00:00
thread_pthread.c * vm.c: support variable VM/Machine stack sizes. 2012-12-19 22:29:18 +00:00
thread_pthread.h
thread_win32.c * thread_win32.c: catch up latest change of BLOCKING_REGION. 2012-11-28 13:57:52 +00:00
thread_win32.h thread_win32.h: rb_thread_lock_t for USE_WIN32_MUTEX 2012-06-17 07:21:03 +00:00
time.c time.c: st_update 2012-12-12 09:27:12 +00:00
timev.h
transcode.c update doc. 2012-04-24 13:52:13 +00:00
transcode_data.h Supports static linking of extensions and encodings again. 2012-05-16 05:39:06 +00:00
util.c Imports Ruby's port to NativeClient (a.k.a NaCl). 2012-05-17 02:48:59 +00:00
variable.c internal.h: quote unprintable 2012-12-22 15:04:57 +00:00
version.c * eval.c: Add doxygen comments. 2012-06-14 02:21:51 +00:00
version.h * 2012-12-26 2012-12-25 16:04:57 +00:00
vm.c * vm_trace.c (rb_threadptr_exec_event_hooks_and_pop_frame): 2012-12-25 13:24:17 +00:00
vm_backtrace.c * vm_backtrace.c (vm_backtrace_to_ary): check negative size (2nd arg). 2012-12-03 07:23:57 +00:00
vm_core.h * vm_trace.c (rb_threadptr_exec_event_hooks_and_pop_frame): 2012-12-25 13:24:17 +00:00
vm_debug.h * include/ruby/debug.h: introdudced. 2012-11-20 12:57:49 +00:00
vm_dump.c * vm_dump.c (rb_vm_bugreport): revert r38533. 2012-12-21 17:21:12 +00:00
vm_eval.c * vm_core.h, eval_intern.h (CHECK_STACK_OVERFLOW): move 2012-12-25 09:57:07 +00:00
vm_exec.c * vm_exec.c: check VM_COLLECT_USAGE_DETAILS. 2012-12-03 11:38:43 +00:00
vm_exec.h * vm_exec.h (GENTRY): GENTRY should be pointer size. 2012-11-15 13:42:27 +00:00
vm_insnhelper.c * vm_core.h, eval_intern.h (CHECK_STACK_OVERFLOW): move 2012-12-25 09:57:07 +00:00
vm_insnhelper.h * vm_insnhelper.h: partly revert r37631 (DTrace support). 2012-11-22 06:28:17 +00:00
vm_method.c internal.h: quote unprintable 2012-12-22 15:04:57 +00:00
vm_opts.h * vm_opts.h: enable optimization - operand unifications. 2012-12-04 04:57:50 +00:00
vm_trace.c * vm_trace.c (rb_threadptr_exec_event_hooks_and_pop_frame): 2012-12-25 13:24:17 +00:00
vsnprintf.c unecessary macros and K&R style coding 2012-08-16 00:46:12 +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 <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.


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

<mailto:matz@ruby-lang.org>

-------------------------------------------------------
created at: Thu Aug  3 11:57:36 JST 1995
--
Local variables:
mode: rdoc
end: