diff options
author | dave <dave@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2004-08-30 14:22:26 +0000 |
---|---|---|
committer | dave <dave@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2004-08-30 14:22:26 +0000 |
commit | 2ad8cb54289d5bf069d307272869422c429d90b3 (patch) | |
tree | ac67cd6d58dbc0b675cc6e74ab3df2002c0fd503 /bin/ri | |
parent | bf5fde05a171e04fd4ef7354acd673192f6d1ea4 (diff) |
ri now merges the documentation if it finds the same class in multiple places
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_1_8@6838 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'bin/ri')
-rwxr-xr-x | bin/ri | 27 |
1 files changed, 27 insertions, 0 deletions
@@ -12,6 +12,33 @@ # # The form '.' method matches either class or instance methods, while # #method matches only instance and ::method matches only class methods. +# +# +# == Installing Documentation +# +# 'ri' uses a database of documentation built by the RDoc utility. +# +# So, how do you install this documentation on your system? +# It depends on how you installed Ruby. +# +# <em>If you installed Ruby from source files</em> (that is, if it some point +# you typed 'make' during the process :), you can install the RDoc +# documentation yourself. Just go back to the place where you have +# your Ruby source and type +# +# make install-doc +# +# You'll probably need to do this as a superuser, as the documentation +# is installed in the Ruby target tree (normally somewhere under +# <tt>/usr/local</tt>. +# +# <em>If you installed Ruby from a binary distribution</em> (perhaps +# using a one-click installer, or using some other packaging system), +# then the team that produced the package probably forgot to package +# the documentation as well. Contact them, and see if they can add +# it to the next release. +# + require 'rdoc/ri/ri_driver' |