Comment on this RCR (edit wiki page) | RCRchive home

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

submitted by Gavin on 2003-09-28 19:01:49

This is a legacy RCR. If this is your RCR, please resubmit it using the new format and process.

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!

Vote for this RCR

Strongly opposed [0]
Opposed [0]
Neutral [1]
In favor [6]
Strongly advocate [12]

Change the status of this RCR to:

accepted

rejected

withdrawn

Add comments here

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.

Back to RCRchive.

RCR Submission page and RCRchive powered by Ruby, Apache, RuWiki (modified), and RubLog