diff options
Diffstat (limited to 'lib/rdoc/ri/ri_paths.rb')
| -rw-r--r-- | lib/rdoc/ri/ri_paths.rb | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/lib/rdoc/ri/ri_paths.rb b/lib/rdoc/ri/ri_paths.rb new file mode 100644 index 0000000000..14288d9a94 --- /dev/null +++ b/lib/rdoc/ri/ri_paths.rb @@ -0,0 +1,41 @@ +module RI + + # Encapsulate all the strangeness to do with finding out + # where to find RDoc files + # + # We basically deal with three directories: + # + # 1. The 'system' documentation directory, which holds + # the documentation distributed with Ruby, and which + # is managed by the Ruby install process + # 2. The 'site' directory, which contains site-wide + # documentation added locally. + # 3. The 'user' documentation directory, stored under the + # user's own home directory. + # + # There's contention about all this, but for now: + # + # system:: $prefix/lib/ruby/<version>/doc/rdoc + # site:: $prefix/lib/ruby/site_dir/<version>/doc/rdoc + # user:: ~/.rdoc + + module Paths + + #:stopdoc: + require 'rbconfig' + + DOC_DIR = "doc/rdoc" + + SYSDIR = File.join(Config::CONFIG['rubylibdir'], DOC_DIR) + SITEDIR = File.join(Config::CONFIG['sitelibdir'], DOC_DIR) + homedir = ENV['HOME'] || ENV['USERPROFILE'] || ENV['HOMEPATH'] + + if homedir + HOMEDIR = File.join(homedir, ".rdoc") + else + HOMEDIR = nil + end + + PATH = [ SYSDIR, SITEDIR, HOMEDIR ].find_all {|p| p && File.directory?(p)} + end +end |