diff options
| -rwxr-xr-x | bin/puppetdoc | 32 | ||||
| -rw-r--r-- | lib/puppet/type/pfile.rb | 8 | ||||
| -rw-r--r-- | lib/puppet/type/service.rb | 8 |
3 files changed, 23 insertions, 25 deletions
diff --git a/bin/puppetdoc b/bin/puppetdoc index 314d4078b..ac162f27e 100755 --- a/bin/puppetdoc +++ b/bin/puppetdoc @@ -118,10 +118,11 @@ end # Print the docs for arguments def self.arguments - puts %{ -=========================== -Puppet Executable Reference -=========================== + puts %{--- +inMenu: true +title: Executable Reference +--- +# Puppet Executable Reference Every Puppet executable (with the exception of ``puppetdoc``) accepts all of these arguments, but not all of the arguments make sense for every executable. @@ -159,10 +160,12 @@ end # Print the docs for types def self.types - puts %{ -============== -Type Reference -============== + puts %{--- +inMenu: true +title: Type Reference +--- +# Type Reference + } @@ -171,9 +174,7 @@ Type Reference types[type.name] = type } puts %{ ---------------- -Meta-Parameters ---------------- +## Meta-Parameters Metaparameters are parameters that work with any element; they are part of the Puppet framework itself rather than being part of the implementation of any @@ -201,9 +202,7 @@ in your manifest, including defined components. end puts %{ ------ -Types ------ +## Types - *namevar* is the parameter used to uniquely identify a type instance. This is the parameter that gets assigned when a string is provided before @@ -242,8 +241,7 @@ Types " puts " -%s -%s" % [name, "=" * (name.to_s.length + 4)] +## %s" % name #String.new('n%s\n') % name.to_s #puts "**" + type.doc.gsub(/\n\s*/, ' ') + "**\n\n" puts scrub(type.doc) + "\n\n" @@ -294,7 +292,7 @@ Types #puts tab(1) + state.doc.gsub(/\n\s*/,' ') } - puts "\n%s Parameters\n''''''''''''''''''''''''''''''" % name.to_s.capitalize + puts "\n### %s Parameters\n" % name.to_s.capitalize type.parameters.sort { |a,b| a.to_s <=> b.to_s }.each { |name,param| diff --git a/lib/puppet/type/pfile.rb b/lib/puppet/type/pfile.rb index 7ff7576ab..f16c67eb9 100644 --- a/lib/puppet/type/pfile.rb +++ b/lib/puppet/type/pfile.rb @@ -44,10 +44,10 @@ module Puppet server => puppet } - ``puppetmasterd`` creates a filebucket by default, so you can - usually back up to your main server with this configuration. Once - you've described the bucket in your configuration, you can use - it in any file:: + The ``puppetmasterd`` daemon creates a filebucket by default, + so you can usually back up to your main server with this + configuration. Once you've described the bucket in your + configuration, you can use it in any file:: file { \"/my/file\": source => \"/path/in/nfs/or/something\", diff --git a/lib/puppet/type/service.rb b/lib/puppet/type/service.rb index 658027360..b65a8cd54 100644 --- a/lib/puppet/type/service.rb +++ b/lib/puppet/type/service.rb @@ -154,11 +154,11 @@ module Puppet sense to set this parameter, as the default is based on the builtin service facilities. The service types available are: - * ``base``: You must specify everything. - * ``init``: Assumes ``start`` and ``stop`` commands exist, but you + * **base**: You must specify everything. + * **init**: Assumes ``start`` and ``stop`` commands exist, but you must specify everything else. - * ``debian``: Debian's own specific version of ``init``. - * ``smf``: Solaris 10's new Service Management Facility. + * **debian**: Debian's own specific version of ``init``. + * **smf**: Solaris 10's new Service Management Facility. " defaultto { @parent.class.defaulttype } |