Current File : //proc/thread-self/root/opt/alt/ruby18/share/ri/1.8/system/RI/Paths/cdesc-Paths.yaml |
--- !ruby/object:RI::ClassDescription
attributes: []
class_methods: []
comment:
- !ruby/struct:SM::Flow::P
body: Encapsulate all the strangeness to do with finding out where to find RDoc files
- !ruby/struct:SM::Flow::P
body: "We basically deal with three directories:"
- !ruby/object:SM::Flow::LIST
contents:
- !ruby/struct:SM::Flow::LI
label: "1."
body: The 'system' documentation directory, which holds the documentation distributed with Ruby, and which is managed by the Ruby install process
- !ruby/struct:SM::Flow::LI
label: "2."
body: The 'site' directory, which contains site-wide documentation added locally.
- !ruby/struct:SM::Flow::LI
label: "3."
body: The 'user' documentation directory, stored under the user's own home directory.
type: :NUMBER
- !ruby/struct:SM::Flow::P
body: "There's contention about all this, but for now:"
- !ruby/object:SM::Flow::LIST
contents:
- !ruby/struct:SM::Flow::LI
label: "system:"
body: $datadir/ri/<ver>/system/...
- !ruby/struct:SM::Flow::LI
label: "site:"
body: $datadir/ri/<ver>/site/...
- !ruby/struct:SM::Flow::LI
label: "user:"
body: ~/.rdoc
type: :NOTE
constants: []
full_name: RI::Paths
includes: []
instance_methods: []
name: Paths
superclass: