[Puppet - Bug #14313] Need balanced list of settings to include in each application's help and man page
<tickets <at> puppetlabs.com>
2012-05-07 19:20:53 GMT
Issue #14313 has been updated by Nick Fagerlund.
- Subject changed from puppet agent usage does not mention --color argument to Need balanced list of settings to include in each application's help and man page
- Description updated
- Assignee changed from Nick Fagerlund to Garrett Honeycutt
I’m sick of playing whack-a-mole with these, so I’m changing the summary and description to reflect the real size of the task. Puppet agent can be the first one we try to fix.
Right now, puppet agent has the following “real” options:
These are not settings. The man page also includes the following settings as options:
Garret, what should be added, and why? I am skeptical that color is important enough to make the cut, but can be convinced. Environment seems like a gimme, as does splay. I could see a case for tags.
- Author: Garrett Honeycutt
- Status: Needs More Information
- Priority: Normal
- Assignee: Garrett Honeycutt
- Category: usability
- Target version:
- Affected Puppet version: 2.7.14
Any valid config setting is a valid option for the puppet command line applications. There are over two hundred settings. 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 received this message because you are subscribed to the Google Groups "Puppet Bugs" group.
To post to this group, send email to puppet-bugs <at> googlegroups.com.
To unsubscribe from this group, send email to puppet-bugs+unsubscribe <at> googlegroups.com.
For more options, visit this group at http://groups.google.com/group/puppet-bugs?hl=en.