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
stomar b637593ae7 rdoc for String class
* lib/unicode_normalize.rb: [DOC] prevent a comment from
  showing up in the class documentation for String.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@57777 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2017-03-04 20:02:48 +00:00
basictest basictest: --run-opt option 2016-10-19 05:22:51 +00:00
benchmark benchmarks for Bug#13136 2017-01-20 02:27:28 +00:00
bin
bootstraptest make FIXNUM_MAX visible from Ruby 2017-01-30 10:12:18 +00:00
ccan
coverage
cygwin MFLAGS for nmake 2017-02-10 06:12:22 +00:00
defs fix for cross-compiling 2017-03-02 04:54:18 +00:00
doc Added initial gemspec for SDBM module. 2017-02-28 07:45:54 +00:00
enc Merge Onigmo 6.0.0 2016-12-10 17:47:04 +00:00
ext readline.c: fix type 2017-03-04 05:13:18 +00:00
gems Update gems/bundled_gems 2017-02-15 11:17:53 +00:00
include broken mingw 2017-03-03 04:51:34 +00:00
lib rdoc for String class 2017-03-04 20:02:48 +00:00
man Remove Ns before puctuation 2016-09-26 12:39:18 +00:00
misc ruby-additional.el: unquoted code block 2016-11-16 06:59:40 +00:00
missing get rid of sprintf 2016-12-26 09:28:48 +00:00
nacl
sample pty/shl.rb: update [ci skip] 2017-02-05 01:26:27 +00:00
spec default.mspec: end of options 2016-11-09 02:42:30 +00:00
template MINIRUBY for cross-compling 2017-03-03 06:22:47 +00:00
test refine a warning message. 2017-03-02 23:33:06 +00:00
tool add performance counting mechanism for MRI debug/tuning purpose. 2017-02-21 08:18:15 +00:00
win32 common.mk: separate clean-ext 2017-03-01 07:53:15 +00:00
.document * .document: [DOC] add rbconfig. [ci skip] 2016-09-14 12:52:00 +00:00
.editorconfig Add config for *.yml [ci skip] 2016-10-30 11:57:41 +00:00
.gdbinit .gdbinit: rp_bignum 2017-02-25 02:59:47 +00:00
.gitattributes
.gitignore .gitignore: add ext/rbconfig/sizeof/limits.c 2017-02-03 23:40:59 +00:00
.indent.pro
.travis.yml Add ruby_2_4 branch to test on travis [skip ci] 2016-12-23 16:09:09 +00:00
acinclude.m4
aclocal.m4
addr2line.c get rid of strcpy 2016-12-26 09:28:46 +00:00
addr2line.h
appveyor.yml appveyor.yaml: matrix 2017-02-23 07:14:29 +00:00
array.c documentation for sort methods 2017-03-04 13:13:50 +00:00
bignum.c Makefile.sub: ULL_TO_DOUBLE 2017-02-28 02:58:12 +00:00
BSDL
class.c class.c: non-keyword hash class 2017-01-18 03:38:52 +00:00
common.mk MINIRUBY for cross-compling 2017-03-03 06:22:47 +00:00
compar.c Comparable#clamp 2016-08-11 07:24:25 +00:00
compile.c compile.c: operand size check 2017-03-04 14:44:05 +00:00
complex.c complex.c: remove deprecated functions 2017-02-21 06:07:21 +00:00
configure.in broken mingw 2017-03-03 04:51:34 +00:00
constant.h
cont.c cont.c: avoid needless branch for dmark callbacks 2017-02-13 01:05:23 +00:00
CONTRIBUTING.md
COPYING COPYING: expand tabs 2017-02-18 22:38:35 +00:00
COPYING.ja
debug.c * debug.c (ruby_debug_printf): use rb_raw_obj_info() 2016-07-25 08:00:46 +00:00
debug_counter.c add performance counting mechanism for MRI debug/tuning purpose. 2017-02-21 08:18:15 +00:00
debug_counter.h add performance counting mechanism for MRI debug/tuning purpose. 2017-02-21 08:18:15 +00:00
dir.c dir.c: getattrlist on OSX 10.5 2017-01-01 22:20:38 +00:00
dln.c get rid of strcpy 2016-12-26 09:28:46 +00:00
dln.h
dln_find.c dln_find.c: MAXPATHLEN is not used already 2016-06-02 16:52:15 +00:00
dmydln.c * configure.in: add -Wsuggest-attribute=noreturn and suppress warnings. 2016-05-08 00:55:28 +00:00
dmyenc.c
dmyext.c
encindex.h
encoding.c encoding.c: handle needmore error from rb_enc_precise_mbclen() 2016-12-14 12:32:42 +00:00
enum.c documentation for sort methods 2017-03-04 13:13:50 +00:00
enumerator.c Enumerator::Lazy#chunk_while defined. 2016-11-05 15:46:48 +00:00
error.c error.c: remove deprecated internal features 2017-02-21 06:07:22 +00:00
eval.c eval.c: hide internal objects 2017-02-03 06:23:34 +00:00
eval_error.c eval_error.c: backstrace in reverse order 2017-02-22 08:50:25 +00:00
eval_intern.h eval_intern.h: make TH_PUSH_TAG() initialize rb_vm_tag::tag with Qundef 2016-09-26 06:43:51 +00:00
eval_jump.c
file.c file.c: refine message 2017-01-16 02:43:55 +00:00
gc.c get rid of strcpy 2016-12-26 09:28:46 +00:00
gc.h
gem_prelude.rb
golf_prelude.rb
goruby.c goruby.c: call Init_golf [ci skip] 2016-08-23 08:00:09 +00:00
GPL
hash.c hash.c: [DOC] fix book title in example 2017-03-01 19:57:14 +00:00
ia64.s
id_table.c swithc id_table data structure. 2017-01-25 03:03:52 +00:00
id_table.h id_table.h: dummy sentinel 2016-08-06 00:35:33 +00:00
inits.c
insns.def Use carry flag to reduce instructions 2017-02-02 15:54:51 +00:00
internal.h eval_error.c: backstrace in reverse order 2017-02-22 08:50:25 +00:00
io.c io.c: documentation for puts 2017-03-03 19:39:35 +00:00
iseq.c immediate message mode of compile error 2017-01-12 07:41:35 +00:00
iseq.h * iseq.h (struct iseq_compile_data): use struct rb_id_table 2016-05-14 18:43:11 +00:00
KNOWNBUGS.rb add a ticket number. 2017-01-30 07:39:27 +00:00
LEGAL Use https instead of http in some URLs 2016-09-11 10:33:36 +00:00
lex.c.blt
load.c deduplicate strings sooner at load and compile 2017-03-01 01:16:26 +00:00
loadpath.c
localeinit.c * remove trailing spaces. 2016-06-19 06:01:26 +00:00
main.c
Makefile.in common.mk: separate clean-ext 2017-03-01 07:53:15 +00:00
marshal.c marshal.c: revert r57631 partially 2017-02-15 08:38:01 +00:00
math.c math.c: unused_obj 2016-11-19 01:55:34 +00:00
method.h * eval.c, method.h, proc.c, vm.c, vm_eval.c, vm_insnhelper.c, vm_method.c: 2016-11-05 13:15:26 +00:00
miniinit.c
NEWS add NEWS for Random.urandom [ci skip] 2017-02-27 13:41:38 +00:00
node.c fix nd_ainfo->kw_rest_arg 2017-02-27 13:52:08 +00:00
node.h
numeric.c [DOC] update doc. 2017-03-02 23:36:13 +00:00
object.c numeric.c: Numeric#clone and #dup 2017-02-22 02:02:11 +00:00
pack.c backward.h: 2.2 deprecated features 2017-02-21 05:17:41 +00:00
parse.y kwrest arg name 2017-02-27 13:52:07 +00:00
prelude.rb Revert r57690 except for read_nonblock 2017-02-23 02:40:17 +00:00
probes.d
probes_helper.h
proc.c proc.c: documentation for Proc#{call,yield,[]} 2017-03-03 08:45:04 +00:00
process.c process.c: PATH env in spawn 2016-11-06 00:58:49 +00:00
random.c SecureRandom should try /dev/urandom first [Bug #9569] 2017-01-20 08:00:00 +00:00
range.c range.c: check loading 2016-11-11 11:52:03 +00:00
rational.c rational.c: infinity in power 2017-02-22 23:49:40 +00:00
re.c refine a warning message. 2017-03-02 23:33:06 +00:00
README.EXT
README.EXT.ja
README.ja.md README{,.ja}.md: Drop support for BeOS now that Haiku is stable since 2.3.0. [ci skip] 2016-09-13 12:26:04 +00:00
README.md Describe about RUBY_CODESIGN 2017-01-31 10:37:50 +00:00
regcomp.c Merge Onigmo 6.1.1 2017-02-11 15:08:33 +00:00
regenc.c Merge Onigmo 6.1.1 2017-02-11 15:08:33 +00:00
regenc.h Merge Onigmo 6.0.0 2016-12-10 17:47:04 +00:00
regerror.c get rid of strcat 2016-12-26 09:28:47 +00:00
regexec.c Merge Onigmo 6.1.1 2017-02-11 15:08:33 +00:00
regint.h Merge Onigmo 6.1.1 2017-02-11 15:08:33 +00:00
regparse.c regparse.c: initialize return values 2017-02-20 09:46:12 +00:00
regparse.h Merge Onigmo 6.1.1 2017-02-11 15:08:33 +00:00
regsyntax.c Merge Onigmo 6.0.0 2016-12-10 17:47:04 +00:00
ruby-runner.c
ruby.c ruby.c: defining DATA 2017-01-31 12:55:00 +00:00
ruby_assert.h
ruby_atomic.h
rubystub.c rubystub.c: sys/param.h for MAXPATHLEN 2016-08-20 05:58:58 +00:00
safe.c
signal.c signal.c: improve stack overflow check 2016-11-27 11:22:42 +00:00
siphash.c switch SipHash from SipHash24 to SipHash13 variant 2017-01-20 06:01:23 +00:00
siphash.h switch SipHash from SipHash24 to SipHash13 variant 2017-01-20 06:01:23 +00:00
sparc.c
sprintf.c sprintf.c: avoid garbage in common (no exception) case 2017-01-31 00:41:56 +00:00
st.c st.c: suppress a warning 2016-12-21 11:20:02 +00:00
strftime.c strftime.c: limit result size 2016-06-14 13:22:09 +00:00
string.c string.c: restore documentation for String#<< 2017-03-02 10:31:56 +00:00
struct.c struct.c: improve rdoc for Struct 2017-03-01 19:59:03 +00:00
symbol.c symbol.c (rb_id2str): eliminate branch to set class 2017-02-03 23:55:06 +00:00
symbol.h Use HAVE_BUILTIN___BUILTIN_CONSTANT_P 2016-05-20 13:33:10 +00:00
thread.c Thread#fetch 2017-02-22 07:16:13 +00:00
thread_pthread.c [DOC] replace Fixnum with Integer [ci skip] 2016-10-26 06:11:23 +00:00
thread_pthread.h
thread_sync.c allow Queue operation in trap. 2017-01-31 07:00:38 +00:00
thread_win32.c Use PRIuSIZE format specifier for size_t values 2016-09-13 12:33:13 +00:00
thread_win32.h
time.c time.c (time_strftime): avoid garbage in common case 2017-01-31 02:18:58 +00:00
timev.h
transcode.c * lib/net/http/header.rb: Fix typo. [ci skip][fix GH-1407] 2016-08-16 02:18:51 +00:00
transcode_data.h
util.c fix for mingw64 2017-03-03 06:18:36 +00:00
variable.c add performance counting mechanism for MRI debug/tuning purpose. 2017-02-21 08:18:15 +00:00
version.c
version.h * 2017-03-05 2017-03-04 19:52:31 +00:00
vm.c backward.h: 2.2 deprecated features 2017-02-21 05:17:41 +00:00
vm_args.c vm_args.c: cache procs 2016-10-15 09:05:58 +00:00
vm_backtrace.c * vm_trace.c (tracepoint_attr_callee_id, rb_tracearg_callee_id): 2016-11-05 13:15:27 +00:00
vm_core.h use rb_iseq_check() for USE_LAZY_LOAD, too. 2017-02-16 09:15:26 +00:00
vm_debug.h
vm_dump.c skip T_IMEMO for VMDEBUG 2017-01-26 09:57:41 +00:00
vm_eval.c vm.c: fix return in lambda 2016-12-31 08:07:58 +00:00
vm_exec.c * vm_insnhelper.h: rename REG_(CFP|PC|SP|EP) to VM_REG_.... 2016-11-05 16:31:25 +00:00
vm_exec.h
vm_insnhelper.c add performance counting mechanism for MRI debug/tuning purpose. 2017-02-21 08:18:15 +00:00
vm_insnhelper.h insns.def: float comparison 2017-01-13 05:49:43 +00:00
vm_method.c add performance counting mechanism for MRI debug/tuning purpose. 2017-02-21 08:18:15 +00:00
vm_opts.h
vm_trace.c Add clang volatile fixes from FreeBSD and NetBSD. 2016-12-07 23:27:51 +00:00
vsnprintf.c * internal.h (WARN_UNUSED_RESULT): moved to configure.in, to 2016-09-16 06:15:55 +00:00

Build Status Build status

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 (e.g. class, method calls)
  • Advanced Object-oriented Features (e.g. Mix-in, Singleton-method)
  • Operator Overloading
  • Exception Handling
  • Iterators and Closures
  • Garbage Collection
  • Dynamic Loading of Object Files (on some architectures)
  • Highly Portable (works on many Unix-like/POSIX compatible platforms as well as Windows, Mac OS X, Haiku, etc.) cf. https://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:

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

The Ruby distribution files can be found on 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 https://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 to see the list of branches:

$ svn ls https://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:

https://www.ruby-lang.org/

Mailing list

There is a mailing list to talk about Ruby. To subscribe to this list, please send the following phrase:

subscribe

in the mail body (not subject) to the address mailto:ruby-talk-request@ruby-lang.org.

How to compile and install

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

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

  2. If ./configure does not exist or is older than configure.in, run autoconf to (re)generate configure.

  3. 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.

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

  5. 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 do not allow dynamic loading), remove comment mark from the line "#option nodynamic" in ext/Setup.

    Usually this step will not be needed.

  6. Run make.

    • On Mac, set RUBY_CODESIGN environment variable with a signing identity. It uses the identity to sign ruby binary. See also codesign(1).
  7. 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).

  8. Run 'make install'

    This command will create the following directories and install files into 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.

Some extension libraries may not get compiled because of lack of necessary external libraries and/or headers, then you will need to run 'make distclean-ext' 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 (https://www.ruby-lang.org/en/community/mailing-lists) or on websites like (https://stackoverflow.com).

Bug reports should be filed at https://bugs.ruby-lang.org. Read HowToReport for more information.

##Contributing

See the file CONTRIBUTING.md

The Author

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

mailto:matz@ruby-lang.org