Gem::DocManager is still present but is no longer required nor used by RubyGems.

Gem::RDoc replaces Gem::DocManager and uses a new hook to generate 
documentation (Gem.done_installing).  The functionality of Gem::RDoc will be 
moving to a future version of rdoc.

The file rubygems/rdoc.rb will continue to exist to facilitate loading of the 
proper code.

Additionally, --no-rdoc and --no-ri are now deprecated:

$ gem help install
[…]
  Deprecated Options:
        --[no-]rdoc                  Generate RDoc for installed gems
                                     Use --document instead
        --[no-]ri                    Generate ri data for installed gems.
                                     Use --document instead
[…]

Replacing these is --document which accepts a comma separated list of 
documentation types to generate.  `gem install rake --doc=rdoc` will generate 
only RDoc.  `gem install rake --doc=rdoc,ri` is the default.  `gem install rake 
--no-doc` will generate no documentation.

Gem::RDoc uses a new done_installing hook to generate documentation which is 
called with a Gem::DependencyInstaller instance and a list of 
Gem::Specifications that have been installed.

Additionally the documentation types are available through the installer 
instance passed to the done_installing hook:

Gem.done_installing do |installer, specs|
  if installer.document.include? 'pretend' then
    puts "Pretending to document: #{specs.map { |spec| spec.full_name }}"
  end
end
_______________________________________________
Rubygems-developers mailing list
http://rubyforge.org/projects/rubygems
Rubygems-developers@rubyforge.org
http://rubyforge.org/mailman/listinfo/rubygems-developers

Reply via email to