using ri with gems

[msoulier]

When I install a new gem, it runs rdoc on the source to pull out docs
that are then available via the gem_server on localhost 8808. Being a
long-time Perl programmer, I want perldoc.

If I install say, Text::CSV from the CPAN, I can then run

perldoc Text::CSV

to get the docs from it.

Conversely, I just installed the net-ssh gem.

[msoulier@tigger ~]$ gem list --local | grep ssh
net-ssh (1.0.9)
[msoulier@tigger ~]$ ri net-ssh
Nothing known about net-ssh
[msoulier@tigger ~]$ ri net/ssh
Nothing known about net/ssh
[msoulier@tigger ~]$ ri Net::SSH
Nothing known about Net::SSH

So, what is ri for? Seems to work on built-in classes like Array, but
not gem code.

Thanks,
Mike

 

[Minkoo Seo]

Hi Mike.

ri seems to be broken in old version (stable release), but it might
be corrected in the latest releaes.

Anyway, here's how to fix ri problem for gem:
http://lists.rubyonrails.org/pipermail/rails/2006-January/014829.html

 

[Austin Ziegler]

ri seems to be broken in old version (stable release), but it might
be corrected in the latest releaes.

Anyway, here's how to fix ri problem for gem:
http://lists.rubyonrails.org/pipermail/rails/2006-January/014829.html

Use gemri for now.

It's a new command in the latest RubyGems release, but it gives ri
capabilities to gems.

-austin

 

[msoulier]

Use gemri for now.

It's a new command in the latest RubyGems release, but it gives ri
capabilities to gems.

I have the latest release, and I don't see a gemri executable.

Mike

 

[Austin Ziegler]

I have the latest release, and I don't see a gemri executable.

I just did:

gem update --system

Then I was able to do:

gemri

and get results. You must be using RubyGems 0.9.0.

-austin

 

[msoulier]

I just did:

gem update --system

Then I was able to do:

gemri

and get results. You must be using RubyGems 0.9.0.

Yup, that worked. Mind you...

[msoulier@tigger ~]$ gemri Net::SSH
Nothing known about Net::SSH
[msoulier@tigger ~]$ gemri net-ssh
Nothing known about net-ssh
[msoulier@tigger ~]$ gemri net/ssh
Nothing known about net/ssh

irb(main):001:0> require 'rubygems'
=> true
irb(main):002:0> require 'net/ssh'
=> true

So, how do I pull up the docs?

Mike

 

[Austin Ziegler]

Yup, that worked. Mind you...

[msoulier@tigger ~]$ gemri Net::SSH
Nothing known about Net::SSH
[msoulier@tigger ~]$ gemri net-ssh
Nothing known about net-ssh
[msoulier@tigger ~]$ gemri net/ssh
Nothing known about net/ssh

irb(main):001:0> require 'rubygems'
=> true
irb(main):002:0> require 'net/ssh'
=> true

So, how do I pull up the docs?

If Net::SSH has rdoc disabled, you'll not get docs or ri. If you
installed Net::SSH before upgrading, you'll have to do something to
generate the ri data.

% gem rdoc net-ssh
% gemri Net::SSH

-austin

 

[msoulier]

If Net::SSH has rdoc disabled, you'll not get docs or ri. If you
installed Net::SSH before upgrading, you'll have to do something to
generate the ri data.

% gem rdoc net-ssh
% gemri Net::SSH

Ok, did that.

-------------------------------------------------------- Class:
Net::SSH
(no description...)
------------------------------------------------------------------------


Constants:
----------
EXTERNAL_SERVICES: Hash.new


Instance methods:
-----------------
register_service, start

Wow, not much there. There's a lot more in the html docs provided for
the gem_server. I guess for some reason these are not one and the same?
That's odd.

Mike