Issue #14313 has been updated by Nick Fagerlund.

Garrett Honeycutt wrote:
> If it is a valid option, it should be in the docs. We should not have secret 
> options.

Naaaaah, "valid" is a pointless distinction here; I'm asking what settings are 
relevant, which is a squishier metric. You can specify `catalog_format` on the 
command line, but no way am I allowing that in the man page. (And it's not 
secret anyway; there's a note in the man page pointing to the config reference, 
which has everything. That's more than good enough for most of these; I just 
want the eight or nine for which it's not good enough.)

Thanks for the note on what you teach in training, that helps. 
----------------------------------------
Bug #14313: Need balanced list of settings to include in each application's 
help and man page
https://projects.puppetlabs.com/issues/14313#change-62270

Author: Garrett Honeycutt
Status: Needs More Information
Priority: Normal
Assignee: Garrett Honeycutt
Category: usability
Target version: 
Affected Puppet version: 2.7.14
Keywords: 
Branch: 


Any valid config setting is a valid option for the puppet command line 
applications. [There are over two hundred 
settings.](http://docs.puppetlabs.com/references/latest/configuration.html#daemonize)
 Even after adjusting for only settings that pertain to a given application, 
it's not sane to print every potentially useful setting in the man page. Long 
term, we must fix this by reducing the number of settings. 

In the meantime, each application should probably include some settings under 
its list of options. For the Faces apps, we'll have a built-in way to pull in 
settings in Telly; for legacy apps, I don't see any solution but manually 
pasting in the relevant settings.

These lists must include important settings, but must be limited enough that 
the man page doesn't balloon out of control and become useless. Many useful but 
non-crucial settings will be left out of each man page. 


-- 
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].
For more options, visit this group at 
http://groups.google.com/group/puppet-bugs?hl=en.

Reply via email to