Issue #18822 has been reported by Josh Cooper.

----------------------------------------
Bug #18822: Puppet ri/rdoc installed via gem has issues
https://projects.puppetlabs.com/issues/18822

Author: Josh Cooper
Status: Accepted
Priority: Low
Assignee: 
Category: documentation
Target version: 
Affected Puppet version: 
Keywords: 
Branch: 


During install I get the following non-fatal error:

<pre>
gem install puppet-3.1.0.rc1.89.gem --ri --rdoc
Successfully installed puppet-3.1.0.rc1.89
1 gem installed
Installing ri documentation for puppet-3.1.0.rc1.89...
Installing RDoc documentation for puppet-3.1.0.rc1.89...
Could not find main page README.md
Could not find main page README.md
Could not find main page README.md
Could not find main page README.md
</pre>

This behavior has been around at least since 2.7.12. But the real problem is 
that the rdoc is useless. The top-level documentation for `Puppet` is a 
conglomeration of files like `lib/puppet/type/file/selcontext.rb` that have 
documentation above `module Puppet`:

<pre>
The majority of Puppet’s configuration settings are set in this file.

Manage file modes. This state should support different formats for 
specification (e.g., u+rwx, or -0011), but for now only supports specifying the 
full mode.

Manage SELinux context of files.

This code actually manages three pieces of data in the context.

[root@delenn files]# ls -dZ / drwxr-xr-x root root system_u:object_r:root_t /

The context of ‘/’ here is ‘system_u:object_r:root_t’. This is three seperate 
fields:

system_u is the user context object_r is the role context root_t is the type 
context

All three of these fields are returned in a single string by the output of the 
stat command, but set individually with the chcon command. This allows the user 
to specify a subset of the three values while leaving the others alone.

See www.nsa.gov/selinux/ for complete docs on SELinux.

Simple module for logging messages on the client-side

Manage a router abstraction

This is our main way of managing processes right now.

a service is distinct from a process in that services can only be managed 
through the interface of an init script which is why they have a search path 
for initscripts and such

see the bottom of the file for the rest of the inclusions

A common module for converting between constants and file names.

This system manages an extensible set of metadata about plugins which it ...
</pre>


-- 
You have received this notification because you have either subscribed to it, 
or are involved in it.
To change your notification preferences, please click here: 
http://projects.puppetlabs.com/my/account

-- 
You received this message because you are subscribed to the Google Groups 
"Puppet Bugs" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to 
[email protected].
Visit this group at http://groups.google.com/group/puppet-bugs?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.


Reply via email to