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 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.

After taking a brief tour of the related code, it seems that all of Puppet’s settings are available to all Faces as options. This is a big usability concern as it’s not possible to know all options valid for each Face. This sounds like a good question for UX; maybe we can work with them to come up with some possible suggestions on how we could improve this for our users.

In the meanwhile, maybe we can work with the doc team on some possible documentation improvements to make it more clear — there are hidden options available.

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 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.

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 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.

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 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 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.

[Puppet - Bug #14313] Need balanced list of settings to include in each application's help and man page

<tickets <at> puppetlabs.com>
2012-05-09 07:43:33 GMT

Issue #14313 has been updated by Garrett Honeycutt.

Glad that the root cause has been sorted out.

The --color argument is quite important to me, since that is what I initially created this ticket.

If you were to call the puppet agent in a script, it would output ANSI escape codes which makes reading or parsing the output quite difficult. Part of our Puppet Bootstrap’s often entail running puppet agent -t from a provisioning system as a post part of installation and the output needs to be legible.

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 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 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.

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 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 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.

[Puppet - Bug #14313] Need balanced list of settings to include in each application's help and man page

<tickets <at> puppetlabs.com>
2012-05-09 18:50:22 GMT

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.)

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 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 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.