The Puppet Labs Issue Tracker has Moved: https://tickets.puppetlabs.com

Bug #2453

puppetdoc mixes long class names that look alike

Added by Raphaël Pinson over 4 years ago. Updated over 4 years ago.

Status:ClosedStart date:07/28/2009
Priority:NormalDue date:
Assignee:Brice Figureau% Done:

100%

Category:documentation
Target version:0.25.0
Affected Puppet version:0.24.8 Branch:
Keywords:

We've Moved!

Ticket tracking is now hosted in JIRA: https://tickets.puppetlabs.com

This issue is currently not available for export. If you are experiencing the issue described below, please file a new ticket in JIRA. Once a new ticket has been created, please add a link to it that points back to this Redmine ticket.


Description

I have an “apt” module and a “hebex” module. The “hebex” module declares a “hebex::apt::sources_list” class and a “hebex::apt::sources_list::dop” definition.

When processed through puppetdoc, both class and definition are listed in —debug mode, but none of them appears in the “hebex” module documentation. Instead, “dop” is listed as a define for the “apt::sources_list” class under the “apt” module, and the “sources::list” class is listed twice in the “apt” module (but both links point to the same page).

This is reproduceable with all modules who use 3 levels or more in their naming scheme and have a module named after the second level.

apt_class.pp - This is $modulepath/hebex/manifests/classes/apt.pp (1.52 KB) Raphaël Pinson, 07/28/2009 12:29 pm

apt_def.pp - This is $modulepath/hebex/manifests/definitions/apt.pp (446 Bytes) Raphaël Pinson, 07/28/2009 12:29 pm

History

#1 Updated by Brice Figureau over 4 years ago

  • Category set to documentation
  • Status changed from Unreviewed to In Topic Branch Pending Review
  • Assignee set to Brice Figureau
  • Target version set to 0.25.0
  • % Done changed from 0 to 100
  • 3 changed from Unknown to Trivial

Patch pending review. The patch is available in my github repository branch tickets/master/2453: http://github.com/masterzen/puppet/tree/tickets/master/2453

Raphaël: the patch is quite short and should apply to 0.24.8.

#2 Updated by James Turnbull over 4 years ago

  • Status changed from In Topic Branch Pending Review to Closed

Pushed in commit:8551ece0d55dafceab633ee6eec46fb1c54c1446 in branch master.

#3 Updated by Raphaël Pinson over 4 years ago

It works great, thanks Brice!

Also available in: Atom PDF