From: Dave Thomas <dave@...>
Date: 2003-12-18T00:12:19+09:00
Subject: Re: Where to install documentation


--Apple-Mail-58-1024944931
Content-Transfer-Encoding: 7bit
Content-Type: text/plain;
	charset=US-ASCII;
	format=flowed


On Dec 17, 2003, at 5:54, nobu.nokada@softhome.net wrote:
> $datadir is configurable regardless of $prefix and $libdir.  So
> you can place them as you like.  What I really don't like is
> hard-coded ones like $libdir/SOMETHING.
>

That's compelling: I like the decoupling here: we give the final 
control to the user. So, how about three standard search paths:

     $datadir/rdoc/std/...   -- for doc installed as part of core Ruby
     $datadir/rdoc/site/...  -- for system-wide doc installed by user
    ~/.rdoc                  -- for personal doc

Within each of these directories I could then have:

       ...rdoc/html/...      -- for rdoc generated html
       ...rdoc/ri/...        -- for rdoc generated RI files

(Of course, users can always use rdocs --op option to choose their own 
directories).
Does this work for folks, or am I getting too complicated?

Cheers

Dave

--Apple-Mail-58-1024944931
Content-Transfer-Encoding: 7bit
Content-Type: text/enriched;
	charset=US-ASCII



On Dec 17, 2003, at 5:54, nobu.nokada@softhome.net wrote:

<excerpt>$datadir is configurable regardless of $prefix and $libdir. 
So

you can place them as you like.  What I really don't like is

hard-coded ones like $libdir/SOMETHING.


</excerpt>

That's compelling: I like the decoupling here: we give the final
control to the user. So, how about three standard search paths:


<fixed><fontfamily><param>Courier New</param>    $datadir/rdoc/std/...  
-- for doc installed as part of core Ruby

    $datadir/rdoc/site/...  -- for system-wide doc installed by user

   ~/.rdoc                  -- for personal doc

</fontfamily></fixed> 

Within each of these directories I could then have:


<fixed><fontfamily><param>Courier New</param>      ...rdoc/html/...     
-- for rdoc generated html

      ...rdoc/ri/...        -- for rdoc generated RI files

</fontfamily></fixed>

(Of course, users can always use rdocs --op option to choose their own
directories).

Does this work for folks, or am I getting too complicated?


Cheers


Dave


--Apple-Mail-58-1024944931--