Hello there I''m trying to get my modules to a deployment stage, and for that i would love to have documentation in place. And it''d be awesome to have the stuff in a way so puppetdoc can parse and output stuff. I gather i still have to tell it what it does etc, but I''m not getting anything back, no error no nothing. Has anyone got a module which puppetdoc parses and is generally informative about? I figured it should probably look like puppetca but the whole: # = Name # some text isn''t doing anything. Any ideas what i''m missing? Also, i might be running the command wrong. So for example, i execute `puppetdoc /etc/puppet/modules/ntp_conf/manifest/init.pp` or `puppetdoc --all /etc/puppet/manifest/site.pp` ... neither responds with anything Cheers, chakkerz --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "Puppet Users" group. To post to this group, send email to puppet-users@googlegroups.com To unsubscribe from this group, send email to puppet-users+unsubscribe@googlegroups.com For more options, visit this group at http://groups.google.com/group/puppet-users?hl=en -~----------~----~----~----~------~----~------~--~---
PS: if i add something like: # = Class: ntp_conf or # = Class: # ntp_conf i get: [root@puppetbeta puppet]# puppetdoc --all --verbose --debug modules/ ntp_conf/manifests/init.pp info: scanning: ["modules/ntp_conf/manifests/init.pp"] Could not generate documentation: undefined method `line'' for nil:NilClass Besides there being an error, if it worked, shouldn''t it at least tell me that the class is called ntp_conf? --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "Puppet Users" group. To post to this group, send email to puppet-users@googlegroups.com To unsubscribe from this group, send email to puppet-users+unsubscribe@googlegroups.com For more options, visit this group at http://groups.google.com/group/puppet-users?hl=en -~----------~----~----~----~------~----~------~--~---
Hi Which version of puppet are you using? On Wed, 2009-02-18 at 14:41 -0800, chakkerz wrote:> Hello there > > I''m trying to get my modules to a deployment stage, and for that i > would love to have documentation in place. And it''d be awesome to have > the stuff in a way so puppetdoc can parse and output stuff. > > I gather i still have to tell it what it does etc, but I''m not getting > anything back, no error no nothing. > > Has anyone got a module which puppetdoc parses and is generally > informative about? I figured it should probably look like puppetca but > the whole: > # = Name > # some text > > isn''t doing anything. > > Any ideas what i''m missing? > > Also, i might be running the command wrong. So for example, i execute > `puppetdoc /etc/puppet/modules/ntp_conf/manifest/init.pp` or > `puppetdoc --all /etc/puppet/manifest/site.pp` ... neither responds > with anything >If you are using puppet >= 0.24.7, see puppetdoc documentation (puppetdoc --help or http://www.reductivelabs.com/trac/puppet/wiki/PuppetManifestDocumentation). Puppetdoc (still >= 0.24.7) can also output directly documentation to the console, with the following syntax puppetdoc /path/to/my/puppet/file.pp If it doesn''t print anything, try to run with --debug and --trace. You should also be aware that the documentation must be "attached" to the object, that is the comment must not be separated by blank likes: # this works class this_works ... # this doesn''t work because of the next blank line class this_doesnt_work Also, if you are gathering module documentation (and not documentation for specific classes), put the module documentation in the /path/to/module/README file. Puppetdoc (in rdoc mode) will find it as use it as the module documentation. Hope that helps -- Brice Figureau My Blog: http://www.masterzen.fr/ --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "Puppet Users" group. To post to this group, send email to puppet-users@googlegroups.com To unsubscribe from this group, send email to puppet-users+unsubscribe@googlegroups.com For more options, visit this group at http://groups.google.com/group/puppet-users?hl=en -~----------~----~----~----~------~----~------~--~---
On Wed, 2009-02-18 at 14:45 -0800, chakkerz wrote:> PS: > > if i add something like: > # = Class: ntp_conf > > > or > # = Class: > # ntp_conf > > i get: > [root@puppetbeta puppet]# puppetdoc --all --verbose --debug modules/ > ntp_conf/manifests/init.pp > info: scanning: ["modules/ntp_conf/manifests/init.pp"] > Could not generate documentation: undefined method `line'' for > nil:NilClass > > Besides there being an error, if it worked, shouldn''t it at least tell > me that the class is called ntp_conf?Yes it should have, provided you are running >= 0.24.7. The issue is that something in your manifest makes puppetdoc crash so it doesn''t output anything. Can you try: puppetdoc --all --debug --trace modules/ntp_conf/manifests/init.pp Then with the result, open a redmine ticket so that we get a chance to fix this issue for 0.24.8. If you can also post your manifest so that I can reproduce the issue, that''d be perfect. -- Brice Figureau My Blog: http://www.masterzen.fr/ --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "Puppet Users" group. To post to this group, send email to puppet-users@googlegroups.com To unsubscribe from this group, send email to puppet-users+unsubscribe@googlegroups.com For more options, visit this group at http://groups.google.com/group/puppet-users?hl=en -~----------~----~----~----~------~----~------~--~---
Hello there Brice I think i see, i''m still not sure how i can then actually do something useful with it, (but I''m slightly on the tired side right now, so maybe tomorrow it will fall into place). Thanks for your help... at least i''m getting some output now :) chakkerz --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "Puppet Users" group. To post to this group, send email to puppet-users@googlegroups.com To unsubscribe from this group, send email to puppet-users+unsubscribe@googlegroups.com For more options, visit this group at http://groups.google.com/group/puppet-users?hl=en -~----------~----~----~----~------~----~------~--~---