Permalink
Browse files

Lots of ri improvements, including:

1.) Significant speed boosts.
2.) Fixing the logic that allows sourcing of documentation from different
    directories.
3.) Adding an option to allow the cache to be used or not.
  • Loading branch information...
designingpatts
designingpatts committed Aug 29, 2008
1 parent 6a1a833 commit 9728c7318698537bb66a1f58ddea0d6400e0e150
Showing with 279 additions and 197 deletions.
  1. +12 −5 History.txt
  2. +1 −2 bin/ri
  3. +266 −181 lib/rdoc/ri/driver.rb
  4. +0 −9 lib/rdoc/ri/paths.rb
View
@@ -1,11 +1,15 @@
=== 2.2.0 / 2008-08-28
-* 2 Major Enhancements
+* 3 Major Enhancements
* More extensive unit tests (special thanks to Chris Lowis for contributing
a test).
- * Made ri twice as fast for the most common use cases (when it's reading
- cached information).
+ * Made ri twice as fast for the most common use case of displaying
+ information for a class or a fully-qualified method
+ (i.e., ri Array#flatten, after ri has created a cache the first time that
+ it runs).
+ * Made ri many times faster when searching for an unqualified method (i.e.,
+ ri read, again after the first such search has populated ri's cache)
-* 5 Minor Enhancements
+* 6 Minor Enhancements
* RDoc now adds the package title to the web pages that it generates
for files and classes/modules, which helps them appear better in
search engine results.
@@ -16,8 +20,9 @@
merged into the RDoc module's documentation).
* Improved rdoc's HTML generation speed by about 20% (on Windows, the
boost seems larger).
+ * Provided an ri command-line option to control its caching behavior.
-* 20 Bug fixes:
+* 21 Bug fixes:
* Fixed prototype detection in C parser. Can process ruby 1.8 C files
again.
* Fixed the main page for frameless template. Patch by Marcin Raczkowski.
@@ -50,6 +55,8 @@
all of the source code to be viewed.
* Fixed the missing constant descriptions in the html and frameless
templates.
+ * Fixed the ri command-line options that customize the directories to be
+ searched for documentation.
=== 2.1.0 / 2008-07-20
View
3 bin/ri
@@ -1,6 +1,5 @@
-#!/usr//bin/env ruby
+#!/usr/bin/env ruby
require 'rdoc/ri/driver'
RDoc::RI::Driver.run ARGV
-
Oops, something went wrong.

0 comments on commit 9728c73

Please sign in to comment.