Issue #5491 has been updated by James Turnbull. Status changed from Needs design decision to Rejected
One is online help and can be used to query a single piece of documenation - the other generates the whole reference. ---------------------------------------- Bug #5491: doc vs describe https://projects.puppetlabs.com/issues/5491 Author: Garrett Honeycutt Status: Rejected Priority: Normal Assignee: James Turnbull Category: Target version: Affected Puppet version: 2.6.4 Keywords: describe documention Branch: We currently have two ways to generate documentation. This is leading to confusion, especially since the interface for each is different. Why are there two commands to give me documentation? # puppet describe --help <pre> SYNOPSIS ======== Print help about puppet types on the console. Run with '-h' to get detailed help. </pre> # puppet doc --help <pre> SYNOPSIS ======== Generate a reference for all Puppet types. Largely meant for internal Puppet Labs use. </pre> Why do I have to know the difference? <pre> puppet describe [type] -s puppet doc -r type </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]. For more options, visit this group at http://groups.google.com/group/puppet-bugs?hl=en.
