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 dd8d4f0075 document marshal_dump and marshal_load
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@28017 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2010-05-26 02:50:58 +00:00
bcc32 * README: update. 2010-05-06 03:12:28 +00:00
benchmark
bin * bin/erb: removed trailing spaces. 2010-04-02 04:40:34 +00:00
bootstraptest * iseq_compile_each (NODE_DEFINED): put nil first to fix stack 2010-05-19 10:48:17 +00:00
cygwin
defs
doc * doc/etc.rd, doc/etc.rd.ja: moved from ext/etc. 2010-04-23 05:07:38 +00:00
enc * enc/iso_2022_jp.h: add CP50220. 2010-05-17 06:28:16 +00:00
ext update doc. 2010-05-25 14:26:04 +00:00
include * include/ruby/vm.h, include/ruby/encoding.h: add external 2010-05-25 04:26:50 +00:00
lib * ext/openssl/lib/openssl/x509-internal.rb, lib/forwardable.rb, 2010-05-23 08:48:44 +00:00
man
misc * misc/ruby-style.el (ruby-style-version): take revision if 2010-05-25 07:37:41 +00:00
missing * missing/ffs.c (ffs): fixed for non-zero values. 2010-05-13 12:41:29 +00:00
sample * sample/README: update file list. [ruby-core:28981] 2010-05-03 12:17:04 +00:00
spec * spec/default.mspec (config): . is no longer in $:. 2010-05-08 16:04:22 +00:00
symbian
template * template/fake.rb.in: no need for hook if extmk. 2010-04-24 07:20:28 +00:00
test * regparse.c (add_code_range_to_buf0): fix false negative 2010-05-25 15:12:19 +00:00
tool * tool/change_maker.rb: line number may not present. 2010-05-24 06:32:53 +00:00
win32 * thread.c (subtract_tv): if the rest is zero, should finish waiting 2010-05-20 16:13:35 +00:00
.cvsignore
.document * prelude.rb, .document: Stuff in prelude.rb should be documented 2010-03-29 12:48:43 +00:00
.gdbinit
.gitignore * .gitignore: updated. 2010-05-17 12:31:21 +00:00
.indent.pro
array.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
bignum.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
ChangeLog document marshal_dump and marshal_load 2010-05-26 02:50:58 +00:00
class.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
common.mk * common.mk (change, prelude): phony targets. 2010-05-24 09:31:46 +00:00
compar.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
compile.c * iseq_compile_each (NODE_DEFINED): put nil first to fix stack 2010-05-19 10:48:17 +00:00
complex.c * complex.c, rational.c, lib/cmath.rb, lib/date.rb lib/date/delta*: 2010-04-26 11:14:40 +00:00
configure.in * configure.in (rb_cv_large_fd_select): needed on mingw, even 2010-05-26 01:35:38 +00:00
cont.c * cont.c (fiber_setcontext): Use swapcontext() instead longjmp(). 2010-05-21 18:55:50 +00:00
COPYING
COPYING.ja
debug.c * suppress warnings. 2010-05-21 09:10:23 +00:00
debug.h
dir.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
dln.c * suppress warnings. 2010-05-21 09:10:23 +00:00
dln.h
dln_find.c
dmydln.c
dmyencoding.c
dmyext.c
dmyversion.c
encoding.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
enum.c * enum.c: Documentation: small fixes 2010-05-17 21:51:01 +00:00
enumerator.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
error.c * error.c: fix wrong exception class name in rdoc. 2010-05-24 14:05:33 +00:00
eval.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
eval_error.c
eval_intern.h * vm_core.h (rb_vm_get_sourceline): moved from eval_intern.h for 2010-05-13 04:09:26 +00:00
eval_jump.c
file.c * enum.c: Documentation: small fixes 2010-05-17 21:51:01 +00:00
gc.c * gc.c (gc_sweep): suppres a warning on VC. 2010-05-24 00:21:33 +00:00
gc.h * cont.c (stackgrowdirection): removed duplicated code, use 2010-05-08 16:15:20 +00:00
gem_prelude.rb * gem_prelude.rb (Gem::QuickLoader.load_full_rubygems_library): 2010-04-23 06:31:24 +00:00
golf_prelude.rb
goruby.c
GPL
hash.c * hash.c: Documentation: change => in call-seq to ->. 2010-05-17 21:31:22 +00:00
ia64.s
id.c
inits.c
insns.def * compile.c (iseq_compile_each), vm_insnhelper.c (vm_invoke_block, 2010-05-09 18:21:39 +00:00
io.c * enum.c: Documentation: small fixes 2010-05-17 21:51:01 +00:00
iseq.c * cont.c (fiber_set_stack_location), iseq.c (prepare_iseq_build), 2010-05-16 02:46:16 +00:00
iseq.h
KNOWNBUGS.rb
LEGAL * LEGAL: separated the section for parse.c. contributed by Paul 2010-04-12 12:47:43 +00:00
lex.c.blt
LGPL
load.c * hash.c: Documentation: change => in call-seq to ->. 2010-05-17 21:31:22 +00:00
main.c
Makefile.in * Makefile.in (RUBY_PROGRAM_VERSION): added 2010-04-24 07:27:50 +00:00
marshal.c document marshal_dump and marshal_load 2010-05-26 02:50:58 +00:00
math.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
method.h * vm_method.c (rb_unlink_method_entry, rb_sweep_method_entry): 2010-05-05 17:51:21 +00:00
NEWS * NEWS (io/console): added IO#echo?. 2010-05-09 15:56:58 +00:00
node.c * cont.c (fiber_set_stack_location), iseq.c (prepare_iseq_build), 2010-05-16 02:46:16 +00:00
node.h * bignum.c, node.h, strftime.c, enc/trans/utf8_mac.trans: added explicit casts for supplessing warnings. 2010-03-25 03:08:28 +00:00
numeric.c * numeric.c (rb_num2ulong): explicit cast to suppress a warning. 2010-05-22 08:14:02 +00:00
object.c * ext/openssl/lib/openssl/x509-internal.rb, lib/forwardable.rb, 2010-05-23 08:48:44 +00:00
pack.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
parse.y * parse.y (warn_balanced, parser_yylex): no warnings after closing 2010-05-24 10:00:36 +00:00
prelude.rb Fix :nodoc: definition. [ruby-dev:40949] 2010-04-10 22:09:09 +00:00
proc.c * proc.c (proc_lambda, unnamed_parameters): Small documentation fixes. 2010-05-17 21:07:46 +00:00
process.c * process.c (rb_f_spawn): use correct command name for the error 2010-05-23 23:16:09 +00:00
random.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
range.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
rational.c * complex.c, rational.c, lib/cmath.rb, lib/date.rb lib/date/delta*: 2010-04-26 11:14:40 +00:00
re.c * re.c (rb_reg_s_union_m): update rdoc. [ruby-dev:41354] 2010-05-20 13:52:18 +00:00
README * README: update. 2010-05-06 03:12:28 +00:00
README.EXT
README.EXT.ja
README.ja * README: update. 2010-05-06 03:12:28 +00:00
regcomp.c
regenc.c
regenc.h
regerror.c
regexec.c
regint.h
regparse.c * regparse.c (add_code_range_to_buf0): fix false negative 2010-05-25 15:12:19 +00:00
regparse.h
regsyntax.c
ruby.c * suppress warnings. 2010-05-21 09:10:23 +00:00
safe.c
signal.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
sprintf.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
st.c
strftime.c * time.c: less bignum allocations. 2010-03-31 12:34:31 +00:00
string.c * proc.c (proc_lambda, unnamed_parameters): Small documentation fixes. 2010-05-17 21:07:46 +00:00
struct.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
thread.c * thread.c (subtract_tv): if the rest is zero, should finish waiting 2010-05-20 16:13:35 +00:00
thread_pthread.c * vm_core.c (rb_thread_struct): add a field for sigaltstack. 2010-05-13 16:20:26 +00:00
thread_pthread.h
thread_win32.c * thread_win32.c (w32_wait_events): get GVL before handle interrupt 2010-05-05 11:53:03 +00:00
thread_win32.h
time.c * proc.c (proc_lambda, unnamed_parameters): Small documentation fixes. 2010-05-17 21:07:46 +00:00
timev.h
ToDo
transcode.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
transcode_data.h
util.c * util.c (BSD__hdtoa): suppress a warning. 2010-04-01 21:59:57 +00:00
variable.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
version.c * vm.c (vm_backtrace_each): get rid of use of malloc from signal 2010-04-15 05:38:07 +00:00
version.h * 2010-05-26 2010-05-25 15:12:22 +00:00
vm.c * vm.c (vm_backtrace_each), vm_eval.c (rb_catch_obj): suppress 2010-05-21 03:57:11 +00:00
vm_core.h * vm_core.c (rb_thread_struct): add a field for sigaltstack. 2010-05-13 16:20:26 +00:00
vm_dump.c * eval_intern.h (rb_vm_get_sourceline): add prototype. 2010-05-11 00:57:09 +00:00
vm_eval.c * vm_eval.c (rb_f_caller): update rdoc. a patch from Nobuhiro IMAI 2010-05-24 16:48:00 +00:00
vm_exec.c
vm_exec.h
vm_insnhelper.c * vm_insnhelper.c (vm_invoke_block): iseq_t.type is VALUE. 2010-05-13 07:19:59 +00:00
vm_insnhelper.h
vm_method.c * array.c: Documentation: change => in call-seq to ->. 2010-05-17 21:07:33 +00:00
vm_opts.h
vsnprintf.c * vsnprintf.c (ruby_vsnprintf, ruby_snprintf): suppress warnings. 2010-04-28 01:27:37 +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: