Issue #14200 has been updated by Chris Price.
Status changed from Merged - Pending Release to Code Insufficient
re-opening this because it was deemed that we do need to support backward
compatibility with 2.7.x until we've established a better means of defining
compatibility between modules and various versions of puppet (and hopefully
providing tooling to support that).
The original changeset breaks backwards compatibility because it changes the
naming conventions for faces from ("foo_bar.rb" => "class Foo_bar") to
("foo_bar.rb" => "class FooBar").
Solution for now will be to prefer the "new" (and more standard) naming
pattern, but hack in backwards compatibility for the old pattern. We'll leave
our core faces using the old naming convention, though, because we expect users
will be copying and pasting from them to build their own, and we don't want to
have to explain to them why the thing they copied and pasted from is not
backward compatible.
----------------------------------------
Bug #14200: puppet 'help' docs show invalid description of 'resource'
https://projects.puppetlabs.com/issues/14200#change-62504
Author: Chris Price
Status: Code Insufficient
Priority: Urgent
Assignee: Chris Price
Category: Faces
Target version: 3.0.0
Affected Puppet version:
Keywords:
Branch: https://github.com/puppetlabs/puppet/pull/722
Current state of the world:
run 'puppet help', and you will get the following description for 'resource':
resource API only: interact directly with resources via the RAL.
This is the help for the resource *Face*. However, when you actually run
'puppet resource' on the command line, you end up running the resource
*Application*. So the help docs are completely incorrect.
This is an artifact of the fact that when generating help we scan the Faces
first, and assume that they all must have a corresponding application. Most of
them do, but at least the "resource" one does not. Then, when we scan the
Applications, we throw out any of the ones for which we already found a face by
the same name.
Proposed changes:
1. Change the 'help' face to only scan the applications directory. For each
application, if it inherits from "FaceBase", then we'll go grab the docs from
the Face. If not we'll grab the docs from the application.
2. While I'm in here, I'd like to change the ERB template so that our 'help'
screen doesn't differentiate between faces and apps. Users running this
command are just looking for docs for command line tools. They aren't going to
care about the implementation details of a particular tool, and I don't see any
reason to force that information on them.
Also while I'm in here, I will explore "puppet help resource" and make sure
it's not skipping over the application and going to the face, because that is
not useful for a command-line user.
--
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.
