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

Bug #2702

puppetdoc rdoc mode fails if outputdir not specified

Added by John Barbuto almost 5 years ago. Updated almost 5 years ago.

Status:ClosedStart date:10/06/2009
Priority:NormalDue date:
Assignee:Brice Figureau% Done:

0%

Category:documentation
Target version:0.25.1
Affected Puppet version:0.25.1 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

The RDoc mode in puppetdoc is fantastic, thanks for adding it. I had a problem getting it to work though:

# puppetdoc --mode rdoc
/usr/lib/ruby/1.8/rdoc/dot/dot.rb:28: warning: already initialized constant NODE_OPTS
/usr/lib/ruby/1.8/rdoc/dot/dot.rb:46: warning: already initialized constant EDGE_OPTS
/usr/lib/ruby/1.8/rdoc/dot/dot.rb:76: warning: already initialized constant GRAPH_OPTS
Could not generate documentation: can't convert nil into String

I found it works when @—outputdir@ is specified. According to http://reductivelabs.com/trac/puppet/wiki/PuppetManifestDocumentation, it should be optional and default to doc/.

History

#1 Updated by James Turnbull almost 5 years ago

  • Category set to documentation
  • Status changed from Unreviewed to Accepted
  • Assignee set to Brice Figureau
  • Target version set to 0.25.1

Brice – let me know if you don’t have time.

#2 Updated by John Barbuto almost 5 years ago

I came up with a fix that works for me, feel free to apply. It’s at git://git.barbuto.org/puppet.git tickets/0.25.x/2702

#3 Updated by James Turnbull almost 5 years ago

John – I mailed your patch to the -dev list for comment – you can do this yourself next time with the mail_patches rake task.

#4 Updated by James Turnbull almost 5 years ago

  • Status changed from Accepted to In Topic Branch Pending Review

#5 Updated by John Barbuto almost 5 years ago

Thanks James, will do. I’ve amended my commit to use @unless@ instead of @! if@ as suggested, still on the same branch.

#6 Updated by James Turnbull almost 5 years ago

  • Status changed from In Topic Branch Pending Review to Closed

Pushed in commit:fcce46aaf1413ef1cd275d1e3db76324ea2e1088 in branch 0.25.x

Also available in: Atom PDF