← Back to branch summary

~ubuntu-branches/ubuntu/lucid/puppet/lucid-security

« back to all changes in this revision

Viewing changes to lib/puppet/util/rdoc/generators/puppet_generator.rb

  • Committer: Bazaar Package Importer
  • Author(s): Chuck Short
  • Date: 2009-12-23 00:48:10 UTC
  • mfrom: (1.1.10 upstream) (3.1.7 squeeze)
  • Revision ID: james.westby@ubuntu.com-20091223004810-3i4oryds922g5n59
Tags: 0.25.1-3ubuntu1
* Merge from debian testing.  Remaining changes:
  - debian/rules:
    + Don't start puppet when first installing puppet.
  - debian/puppet.conf, lib/puppet/defaults.rb:
    + Move templates to /etc/puppet
  - lib/puppet/defaults.rb:
    + Fix /var/lib/puppet/state ownership.
  - man/man8/puppet.conf.8: 
    + Fix broken URL in manpage.
  - debian/control:
    + Update maintainer accordint to spec.
    + Puppetmaster Recommends -> Suggests
    + Created puppet-testsuite as a seperate. Allow the users to run puppet's 
      testsuite.
  - tests/Rakefile: Fix rakefile so that the testsuite can acutally be ran.

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/puppet/util/rdoc/generators/puppet_generator.rb
4
4
 
5
5
    # This module holds all the classes needed to generate the HTML documentation
6
6
    # of a bunch of puppet manifests.
7
 
    # 
8
 
    # It works by traversing all the code objects defined by the Puppet RDoc::Parser 
 
7
    #
 
8
    # It works by traversing all the code objects defined by the Puppet RDoc::Parser
9
9
    # and produces HTML counterparts objects that in turns are used by RDoc template engine
10
10
    # to produce the final HTML.
11
 
    # 
 
11
    #
12
12
    # It is also responsible of creating the whole directory hierarchy, and various index
13
13
    # files.
14
 
    # 
 
14
    #
15
15
    # It is to be noted that the whole system is built on top of ruby RDoc. As such there
16
16
    # is an implicit mapping of puppet entities to ruby entitites:
17
17
    #
20
20
    #         Module          Module
21
21
    #         Class           Class
22
22
    #         Definition      Method
23
 
    #         Resource        
 
23
    #         Resource
24
24
    #         Node
25
25
    #         Plugin
26
26
    #         Fact