ri now merges the documentation if it finds the same class in multiple places

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@6838 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

1 files changed, 27 insertions, 0 deletions

diff --git a/bin/ri b/bin/ri
index 1f5e6a5ff3..fb3e00eda3 100755
--- a/bin/ri
+++ b/bin/ri
@@ -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'