Asp Forum - ri on gentoo - comp.lang.ruby

Jamis Buck

11/7/2004 2:55:00 PM

It works!

For those in a similar situation (where compiling Ruby on gentoo with
the doc USE flag set causes ri to cease working usably), here's how I
managed to get it to work. (Thanks to _ibz on #ruby-lang for his help in
getting this resolved.)

1) Delete the /usr/share/ri/1.8/system directory and all of its contents.

2) cd to a Ruby source directory. (tar xzf
/usr/portage/distfiles/ruby-1.8.2-preview2.tar.gz; cd ruby-1.8.2)

3) run "find . -name '*.rb' -o '*.c' | xargs rdoc18 --all --ri --op
/usr/share/ri/1.8/system"

4) go get something to eat...this will take awhile...

Once that finishes, the ri documentation should be working correctly
again. I'm still not completely sure why the ebuild isn't building the
documentation correctly...maybe someday I'll have more time to delve
into it.

Hope this helps someone.

- Jamis

--
Jamis Buck
jgb3@email.byu.edu
http://www.jamisbuck...

7 Answers

Dave Thomas

11/7/2004 5:50:00 PM

On Nov 7, 2004, at 8:54, Jamis Buck wrote:

> 3) run "find . -name '*.rb' -o '*.c' | xargs rdoc18 --all --ri --op
> /usr/share/ri/1.8/system"
>
> 4) go get something to eat...this will take awhile...

It'd be better to go to the same directory (which should contain a
document file) and just run plain rdoc --op ... That way it'll take a
lot, lot less time, and it'll only document the meaningful stuff.

Cheers

Dave

Ibraheem Umaru-Mohammed

11/7/2004 6:11:00 PM

On Mon, 2004-11-08 at 02:49 +0900, Dave Thomas wrote:
> On Nov 7, 2004, at 8:54, Jamis Buck wrote:
>
> > 3) run "find . -name '*.rb' -o '*.c' | xargs rdoc18 --all --ri --op
> > /usr/share/ri/1.8/system"
> >
> > 4) go get something to eat...this will take awhile...
>
> It'd be better to go to the same directory (which should contain a
> .document file) and just run plain rdoc --op ... That way it'll take a
> lot, lot less time, and it'll only document the meaningful stuff.
>
[...]

Is the source package untarring required? Shouldn't it work from running
rdoc under /usr/lib/ruby/1.8/ ? For some reason this seems to have
worked for some (me), and not others...

Cheers,

--ibz.

Jamis Buck

11/8/2004 12:57:00 AM

Dave Thomas wrote:
>
> On Nov 7, 2004, at 8:54, Jamis Buck wrote:
>
>> 3) run "find . -name '*.rb' -o '*.c' | xargs rdoc18 --all --ri --op
>> /usr/share/ri/1.8/system"
>>
>> 4) go get something to eat...this will take awhile...
>
>
> It'd be better to go to the same directory (which should contain a
> .document file) and just run plain rdoc --op ... That way it'll take a
> lot, lot less time, and it'll only document the meaningful stuff.
>

Yup, that worked, and much faster besides. I'm confused now, though,
since it looked like that was what the ebuild was doing, which resulted
only a handful of the (less-relevant) methods being documented. :(

Thanks, Dave!

- Jamis

--
Jamis Buck
jgb3@email.byu.edu
http://www.jamisbuck...

Dave Thomas

11/8/2004 1:11:00 AM

On Nov 7, 2004, at 12:10, Ibraheem Umaru-Mohammed wrote:
> Is the source package untarring required? Shouldn't it work from
> running
> rdoc under /usr/lib/ruby/1.8/ ? For some reason this seems to have
> worked for some (me), and not others...

You won't get the full or proper documentation that way (for example
you won't see any of the stuff written in C, including the built-in
classes such as String--these are in the C source, not the resulting
binaries).

You also won't be able to take advantage of the .document files that
direct RDoc what to include and what to omit.

In general, if you're looking at using a packaged Ruby, the packager
should also have provided a pre-installed set of ri documentation. If
not, I'd ask them to consider it.

Cheers

Dave

Corey

11/8/2004 1:24:00 AM

On Sunday 07 November 2004 06:11 pm, Dave Thomas wrote:
<snip>
> You won't get the full or proper documentation that way (for example
> you won't see any of the stuff written in C, including the built-in
> classes such as String--these are in the C source, not the resulting
> binaries).
>
> You also won't be able to take advantage of the .document files that
> direct RDoc what to include and what to omit.
>
> In general, if you're looking at using a packaged Ruby, the packager
> should also have provided a pre-installed set of ri documentation. If
> not, I'd ask them to consider it.
>

I'm a gentoo user as well - thanks for this information.

To the other gentoo users reading this thread: I'll go ahead and file
a bug report at bugs.gentoo.org, and will refer to this thread/post.

Hopefully we can get the ebuild fixed asap, in time for 1.8.2-final.

Beers,

Corey

--

"There should be a law, if you support a war, if you think it's worth
the price, that's fine, but you have to put your own precious fluids
on the line. You have to head for the front and hook up with an
infantry unit and help spill the blood."
- Tim O'Brien

Jason Sweat

11/8/2004 2:04:00 AM

On Mon, 8 Nov 2004 10:24:05 +0900, Corey <corey_s@qwest.net> wrote:
>
> I'm a gentoo user as well - thanks for this information.
>
> To the other gentoo users reading this thread: I'll go ahead and file
> a bug report at bugs.gentoo.org, and will refer to this thread/post.
>
> Hopefully we can get the ebuild fixed asap, in time for 1.8.2-final.

Personally, I just altered the dev-lang/ruby ebuild to include the
--enable-install-doc option, and this let ri work just fine after
that. I would lobby to have that either hard coded always on, or
toggled via a USE option in the ruby portage script.

YMMV

Regards,
Jason
--
http://blog.casey...

Corey

11/8/2004 2:17:00 AM

On Sunday 07 November 2004 07:03 pm, Jason Sweat wrote:
> On Mon, 8 Nov 2004 10:24:05 +0900, Corey <corey_s@qwest.net> wrote:
<snip>
> > To the other gentoo users reading this thread: I'll go ahead and file
> > a bug report at bugs.gentoo.org, and will refer to this thread/post.
<snip>
> Personally, I just altered the dev-lang/ruby ebuild to include the
> --enable-install-doc option, and this let ri work just fine after
> that. I would lobby to have that either hard coded always on, or
> toggled via a USE option in the ruby portage script.
>

Ok - well, there was a bug already opened, and apparently there is still
some issue or another for some folks - even when using the suggested
fix as you detailed above.

http://bugs.gentoo.org/show_bug.cg...

At any rate, I'm sure this'll get resolved pretty soon, I went ahead and
added a comment which points to this thread via the ruby-lang archive.
( which, unfortunately, seems a little slow in propagating the most
recent posts. )

Beers,

Corey

--

"I quarrel not with far-off foes, but with those who, near at home,
cooperate with, and do the bidding of those far away, and without
whom the latter would be harmless."
- Henry David Thoreau

comp.lang.ruby

ri on gentoo

Jamis Buck

Dave Thomas

Ibraheem Umaru-Mohammed

Jamis Buck

Dave Thomas

Corey

Jason Sweat

Corey

x Login to ForumsZone