ruby picture

RCR 155: Include CONFIG::Config['rubydocdir'] in rbconfig.rb

Submitted by legacy (Sun Sep 28 23:09:49 UTC 2003)

Abstract

This is a legacy RCR from Ruby Garden, submitted by Gavin. Matz has declared these RCRs obsolete, and asked that their authors resubmit them in the new format.

Ruby would benefit from the introduction of a standard documentation directory. This one seems sensible for Unix-like platforms:

    
  /usr/[local/]doc/ruby/

    

A similar path in a Windows install would look like this:


    
  C:/ruby/doc/ruby

    

The benefit of agreeing on a standard and implementing it is that package installers could use it to install package documentation in a known place.

In order to implement this, we need to change mkconfig.rb so that in a Ruby installation, the documentation directory is accessible via rbconfig.rb, just as we find the "site_ruby" directory and others in this way.

Therefore, I propose that the following line be included in rbconfig.rb (the first line is an existing one for reference):


    
  CONFIG["rubylibdir"] = "$(libdir)/ruby/$(ruby_version)"
+ CONFIG["rubydocdir"] = "$(prefix)/doc/ruby"

Roll on decent, installed package documentation!

Problem

(RCR imported from old format)

Proposal

Analysis

(RCR imported from old format)

Implementation

(RCR imported from old format)
ruby picture
Comments Current voting

Great idea (, 2003-10-02 11:32:32)

Nice. I have voted thusly.

Re: Include CONFIG::Config['rubydocdir'] in rbconfig.rb (, 2003-10-20 01:51:54)

This is good, but I'd recommend defaulting to "$(prefix)/share/doc/ruby", at least on unix. In my experience, that seems to be more in line with most distros' hierarchies.


Strongly opposed 0
Opposed 0
Neutral 0
In favor 0
Strongly advocate 0
ruby picture
If you have registered at RCRchive, you may now sign in below. If you have not registered, you may sign up for a username and password. Registering enables you to submit new RCRs, and vote and leave comments on existing RCRs.
Your username:
Your password:

ruby picture

Powered by .