puppet 2.6.0 → 2.6.1

data/lib/puppet/type/file/ensure.rb

@@ -3,27 +3,27 @@ module Puppet
     require 'etc'
     desc "Whether to create files that don't currently exist.
       Possible values are *absent*, *present*, *file*, and *directory*.
-      Specifying ``present`` will match any form of file existence, and
+      Specifying `present` will match any form of file existence, and
       if the file is missing will create an empty file. Specifying
-      ``absent`` will delete the file (and directory if recurse => true).
+      `absent` will delete the file (and directory if recurse => true).
 
       Anything other than those values will be considered to be a symlink.
-      For instance, the following text creates a link::
+      For instance, the following text creates a link:
 
-        # Useful on solaris
-        file { \"/etc/inetd.conf\":
-          ensure => \"/etc/inet/inetd.conf\"
-        }
+          # Useful on solaris
+          file { \"/etc/inetd.conf\":
+            ensure => \"/etc/inet/inetd.conf\"
+          }
 
-      You can make relative links::
+      You can make relative links:
 
-        # Useful on solaris
-        file { \"/etc/inetd.conf\":
-          ensure => \"inet/inetd.conf\"
-        }
+          # Useful on solaris
+          file { \"/etc/inetd.conf\":
+            ensure => \"inet/inetd.conf\"
+          }
 
       If you need to make a relative link to a file named the same
-      as one of the valid values, you must prefix it with ``./`` or
+      as one of the valid values, you must prefix it with `./` or
       something similar.
 
       You can also make recursive symlinks, which will create a

data/lib/puppet/type/file/mode.rb

@@ -13,14 +13,14 @@ module Puppet
       entries in a directory, and search/traverse allows you to access
       (read/write/execute) those entries.)  Because of this feature, you
       can recursively make a directory and all of the files in it
-      world-readable by setting e.g.::
+      world-readable by setting e.g.:
 
-        file { '/some/dir':
-          mode => 644,
-          recurse => true,
-        }
+          file { '/some/dir':
+            mode => 644,
+            recurse => true,
+          }
 
-      In this case all of the files underneath ``/some/dir`` will have
+      In this case all of the files underneath `/some/dir` will have
       mode 644, and all of the directories will have mode 755."
 
     @event = :file_changed

data/lib/puppet/type/file/selcontext.rb

@@ -56,7 +56,7 @@ module Puppet
 
   Puppet::Type.type(:file).newproperty(:seluser, :parent => Puppet::SELFileContext) do
     desc "What the SELinux user component of the context of the file should be.
-      Any valid SELinux user component is accepted.  For example ``user_u``.
+      Any valid SELinux user component is accepted.  For example `user_u`.
       If not specified it defaults to the value returned by matchpathcon for
       the file, if any exists.  Only valid on systems with SELinux support
       enabled."
@@ -67,7 +67,7 @@ module Puppet
 
   Puppet::Type.type(:file).newproperty(:selrole, :parent => Puppet::SELFileContext) do
     desc "What the SELinux role component of the context of the file should be.
-      Any valid SELinux role component is accepted.  For example ``role_r``.
+      Any valid SELinux role component is accepted.  For example `role_r`.
       If not specified it defaults to the value returned by matchpathcon for
       the file, if any exists.  Only valid on systems with SELinux support
       enabled."
@@ -78,7 +78,7 @@ module Puppet
 
   Puppet::Type.type(:file).newproperty(:seltype, :parent => Puppet::SELFileContext) do
     desc "What the SELinux type component of the context of the file should be.
-      Any valid SELinux type component is accepted.  For example ``tmp_t``.
+      Any valid SELinux type component is accepted.  For example `tmp_t`.
       If not specified it defaults to the value returned by matchpathcon for
       the file, if any exists.  Only valid on systems with SELinux support
       enabled."
@@ -89,8 +89,8 @@ module Puppet
 
   Puppet::Type.type(:file).newproperty(:selrange, :parent => Puppet::SELFileContext) do
     desc "What the SELinux range component of the context of the file should be.
-      Any valid SELinux range component is accepted.  For example ``s0`` or
-      ``SystemHigh``.  If not specified it defaults to the value returned by
+      Any valid SELinux range component is accepted.  For example `s0` or
+      `SystemHigh`.  If not specified it defaults to the value returned by
       matchpathcon for the file, if any exists.  Only valid on systems with
       SELinux support enabled and that have support for MCS (Multi-Category
       Security)."

data/lib/puppet/type/file/source.rb

@@ -12,7 +12,7 @@ module Puppet
     include Puppet::Util::Diff
 
     attr_accessor :source, :local
-    desc "Copy a file over the current file.  Uses ``checksum`` to
+    desc "Copy a file over the current file.  Uses `checksum` to
       determine when a file should be copied.  Valid values are either
       fully qualified paths to files, or URIs.  Currently supported URI
       types are *puppet* and *file*.
@@ -20,47 +20,47 @@ module Puppet
       This is one of the primary mechanisms for getting content into
       applications that Puppet does not directly support and is very
       useful for those configuration files that don't change much across
-      sytems.  For instance::
+      sytems.  For instance:
 
-        class sendmail {
-          file { \"/etc/mail/sendmail.cf\":
-            source => \"puppet://server/modules/module_name/sendmail.cf\"
+          class sendmail {
+            file { \"/etc/mail/sendmail.cf\":
+              source => \"puppet://server/modules/module_name/sendmail.cf\"
+            }
           }
-        }
 
-      You can also leave out the server name, in which case ``puppet agent``
-      will fill in the name of its configuration server and ``puppet apply``
+      You can also leave out the server name, in which case `puppet agent`
+      will fill in the name of its configuration server and `puppet apply`
       will use the local filesystem.  This makes it easy to use the same
       configuration in both local and centralized forms.
 
-      Currently, only the ``puppet`` scheme is supported for source
+      Currently, only the `puppet` scheme is supported for source
       URL's. Puppet will connect to the file server running on
-      ``server`` to retrieve the contents of the file. If the
-      ``server`` part is empty, the behavior of the command-line
-      interpreter (``puppet apply``) and the client demon (``puppet agent``) differs
-      slightly: ``apply`` will look such a file up on the module path
-      on the local host, whereas ``agent`` will connect to the
+      `server` to retrieve the contents of the file. If the
+      `server` part is empty, the behavior of the command-line
+      interpreter (`puppet apply`) and the client demon (`puppet agent`) differs
+      slightly: `apply` will look such a file up on the module path
+      on the local host, whereas `agent` will connect to the
       puppet server that it received the manifest from.
 
-      See the `FileServingConfiguration fileserver configuration documentation`:trac: for information on how to configure
+      See the [fileserver configuration documentation](http://projects.puppetlabs.com/projects/puppet/wiki/File_Serving_Configuration) for information on how to configure
       and use file services within Puppet.
 
       If you specify multiple file sources for a file, then the first
       source that exists will be used.  This allows you to specify
-      what amount to search paths for files::
-
-        file { \"/path/to/my/file\":
-          source => [
-            \"/modules/nfs/files/file.$host\",
-            \"/modules/nfs/files/file.$operatingsystem\",
-            \"/modules/nfs/files/file\"
-          ]
-        }
+      what amount to search paths for files:
+
+          file { \"/path/to/my/file\":
+            source => [
+              \"/modules/nfs/files/file.$host\",
+              \"/modules/nfs/files/file.$operatingsystem\",
+              \"/modules/nfs/files/file\"
+            ]
+          }
 
       This will use the first found file as the source.
 
-      You cannot currently copy links using this mechanism; set ``links``
-      to ``follow`` if any remote sources are links.
+      You cannot currently copy links using this mechanism; set `links`
+      to `follow` if any remote sources are links.
       "
 
     validate do |sources|
@@ -94,6 +94,16 @@ module Puppet
       metadata && metadata.checksum
     end
 
+    # Look up (if necessary) and return remote content.
+    cached_attr(:content) do
+      raise Puppet::DevError, "No source for content was stored with the metadata" unless metadata.source
+
+      unless tmp = Puppet::FileServing::Content.find(metadata.source)
+        fail "Could not find any content at %s" % metadata.source
+      end
+      tmp.content
+    end
+
     # Copy the values from the source to the resource.  Yay.
     def copy_source_values
       devfail "Somehow got asked to copy source values without any metadata" unless metadata

data/lib/puppet/type/filebucket.rb

@@ -16,13 +16,13 @@ module Puppet
       undo transactions.
 
       You will normally want to define a single filebucket for your
-      whole network and then use that as the default backup location::
+      whole network and then use that as the default backup location:
 
-        # Define the bucket
-        filebucket { main: server => puppet }
+          # Define the bucket
+          filebucket { main: server => puppet }
 
-        # Specify it as the default target
-        File { backup => main }
+          # Specify it as the default target
+          File { backup => main }
 
       Puppetmaster servers create a filebucket by default, so this will
       work in a default configuration."
@@ -92,4 +92,3 @@ module Puppet
     end
   end
 end
-

data/lib/puppet/type/group.rb

@@ -89,7 +89,7 @@ module Puppet
 
     newparam(:allowdupe, :boolean => true) do
       desc "Whether to allow duplicate GIDs.  This option does not work on
-        FreeBSD (contract to the ``pw`` man page)."
+        FreeBSD (contract to the `pw` man page)."
 
       newvalues(:true, :false)
 
@@ -97,4 +97,3 @@ module Puppet
     end
   end
 end
-

data/lib/puppet/type/host.rb

@@ -14,10 +14,8 @@ module Puppet
     end
 
     newproperty(:host_aliases) do
-      desc 'Any aliases the host might have.  Multiple values must be
-        specified as an array.  Note that this property is not the same as
-        the "alias" metaparam; use this property to add aliases to a host
-        on disk, and "alias" to aliases for use in your Puppet scripts.'
+      desc "Any aliases the host might have.  Multiple values must be
+        specified as an array."
 
       def insync?(is)
         is == @should
@@ -94,8 +92,7 @@ module Puppet
     end
 
     @doc = "Installs and manages host entries.  For most systems, these
-      entries will just be in ``/etc/hosts``, but some systems (notably OS X)
+      entries will just be in `/etc/hosts`, but some systems (notably OS X)
       will have different solutions."
   end
 end
-

data/lib/puppet/type/k5login.rb

@@ -3,15 +3,15 @@
 # Plug-in type for handling k5login files
 
 Puppet::Type.newtype(:k5login) do
-  @doc = "Manage the .k5login file for a user.  Specify the full path to
-    the .k5login file as the name and an array of principals as the
+  @doc = "Manage the `.k5login` file for a user.  Specify the full path to
+    the `.k5login` file as the name and an array of principals as the
     property principals."
 
   ensurable
 
   # Principals that should exist in the file
   newproperty(:principals, :array_matching => :all) do
-    desc "The principals present in the .k5login file."
+    desc "The principals present in the `.k5login` file."
   end
 
   # The path/name of the k5login file

data/lib/puppet/type/macauthorization.rb

@@ -1,8 +1,7 @@
 Puppet::Type.newtype(:macauthorization) do
 
   @doc = "Manage the Mac OS X authorization database.
-    See:
-    http://developer.apple.com/documentation/Security/Conceptual/Security_Overview/Security_Services/chapter_4_section_5.html for more information."
+    See the [Apple developer site](http://developer.apple.com/documentation/Security/Conceptual/Security_Overview/Security_Services/chapter_4_section_5.html) for more information."
 
   ensurable
 

data/lib/puppet/type/mailalias.rb

@@ -46,4 +46,3 @@ module Puppet
     end
   end
 end
-

data/lib/puppet/type/maillist.rb

@@ -60,4 +60,3 @@ module Puppet
     end
   end
 end
-

data/lib/puppet/type/mcx.rb

@@ -21,8 +21,6 @@ Puppet::Type.newtype(:mcx) do
 
   @doc = "MCX object management using DirectoryService on OS X.
 
-Original Author: Jeff McCune <mccune.jeff@gmail.com>
-
 The default provider of this type merely manages the XML plist as
 reported by the dscl -mcxexport command.  This is similar to the
 content property of the file type in Puppet.
@@ -51,13 +49,13 @@ to other machines.
 
   newparam(:name) do
     desc "The name of the resource being managed.
-    The default naming convention follows Directory Service paths::
+    The default naming convention follows Directory Service paths:
 
-      /Computers/localhost
-      /Groups/admin
-      /Users/localadmin
+        /Computers/localhost
+        /Groups/admin
+        /Users/localadmin
 
-    The ds_type and ds_name type parameters are not necessary if the
+    The `ds_type` and `ds_name` type parameters are not necessary if the
     default naming convention is followed."
     isnamevar
   end
@@ -80,8 +78,10 @@ to other machines.
   newproperty(:content, :required_features => :manages_content) do
     desc "The XML Plist.  The value of MCXSettings in DirectoryService.
     This is the standard output from the system command:
-    dscl localhost -mcxexport /Local/Default/<ds_type>/ds_name
-    Note that ds_type is capitalized and plural in the dscl command."
+        
+        dscl localhost -mcxexport /Local/Default/<ds_type>/ds_name
+    
+    Note that `ds_type` is capitalized and plural in the dscl command."
   end
 
   # JJM Yes, this is not DRY at all.  Because of the code blocks

data/lib/puppet/type/mount.rb

@@ -5,8 +5,8 @@ module Puppet
       information into the mount table. The actual behavior depends
       on the value of the 'ensure' parameter.
 
-      Note that if a ``mount`` receives an event from another resource,
-      it will try to remount the filesystems if ``ensure`` is set to ``mounted``."
+      Note that if a `mount` receives an event from another resource,
+      it will try to remount the filesystems if `ensure` is set to `mounted`."
 
     feature :refreshable, "The provider can remount the filesystem.",
       :methods => [:remount]
@@ -15,10 +15,10 @@ module Puppet
     # call code when sync is called.
     newproperty(:ensure) do
       desc "Control what to do with this mount. Set this attribute to
-        ``umounted`` to make sure the filesystem is in the filesystem table
-        but not mounted (if the filesystem is currently mounted, it will be unmounted).  Set it to ``absent`` to unmount (if necessary) and remove
-        the filesystem from the fstab.  Set to ``mounted`` to add it to the
-        fstab and mount it. Set to ``present`` to add to fstab but not change
+        `umounted` to make sure the filesystem is in the filesystem table
+        but not mounted (if the filesystem is currently mounted, it will be unmounted).  Set it to `absent` to unmount (if necessary) and remove
+        the filesystem from the fstab.  Set to `mounted` to add it to the
+        fstab and mount it. Set to `present` to add to fstab but not change
         mount/unmount status"
 
       newvalue(:defined) do
@@ -149,7 +149,7 @@ module Puppet
 
     newproperty(:dump) do
       desc "Whether to dump the mount.  Not all platform support this.
-        Valid values are ``1`` or ``0``. or ``2`` on FreeBSD, Default is ``0``."
+        Valid values are `1` or `0`. or `2` on FreeBSD, Default is `0`."
 
       if Facter["operatingsystem"].value == "FreeBSD"
         newvalue(%r{(0|1|2)})
@@ -183,7 +183,7 @@ module Puppet
     end
 
     newparam(:path) do
-      desc "The deprecated name for the mount point.  Please use ``name`` now."
+      desc "The deprecated name for the mount point.  Please use `name` now."
 
       def value=(value)
         warning "'path' is deprecated for mounts.  Please use 'name'."
@@ -193,7 +193,7 @@ module Puppet
     end
 
     newparam(:remounts) do
-      desc "Whether the mount can be remounted  ``mount -o remount``.  If
+      desc "Whether the mount can be remounted  `mount -o remount`.  If
         this is false, then the filesystem will be unmounted and remounted
         manually, which is prone to failure."
 
@@ -222,4 +222,3 @@ module Puppet
     end
   end
 end
-

data/lib/puppet/type/notify.rb

@@ -42,4 +42,3 @@ module Puppet
     end
   end
 end
-

data/lib/puppet/type/package.rb

@@ -8,12 +8,12 @@ module Puppet
     @doc = "Manage packages.  There is a basic dichotomy in package
       support right now:  Some package types (e.g., yum and apt) can
       retrieve their own package files, while others (e.g., rpm and sun) cannot.  For those package formats that cannot retrieve
-      their own files, you can use the ``source`` parameter to point to
+      their own files, you can use the `source` parameter to point to
       the correct file.
 
       Puppet will automatically guess the packaging format that you are
       using based on the platform you are on, but you can override it
-      using the ``provider`` parameter; each provider defines what it
+      using the `provider` parameter; each provider defines what it
       requires in order to function, and you must meet those requirements
       to use a given provider."
 
@@ -22,7 +22,7 @@ module Puppet
     feature :uninstallable, "The provider can uninstall packages.",
       :methods => [:uninstall]
     feature :upgradeable, "The provider can upgrade to the latest version of a
-        package.  This feature is used by specifying ``latest`` as the
+        package.  This feature is used by specifying `latest` as the
         desired value for the package.",
       :methods => [:update, :latest]
     feature :purgeable, "The provider can purge packages.  This generally means
@@ -104,7 +104,6 @@ module Puppet
         end
       end
 
-
       defaultto :installed
 
       # Override the parent method, because we've got all kinds of
@@ -181,35 +180,35 @@ module Puppet
       system uses internally, which is sometimes (especially on Solaris)
       a name that is basically useless to humans.  If you want to
       abstract package installation, then you can use aliases to provide
-      a common name to packages::
-
-        # In the 'openssl' class
-        $ssl = $operatingsystem ? {
-          solaris => SMCossl,
-          default => openssl
-        }
-
-        # It is not an error to set an alias to the same value as the
-        # object name.
-        package { $ssl:
-          ensure => installed,
-          alias => openssl
-        }
-
-        . etc. .
-
-        $ssh = $operatingsystem ? {
-          solaris => SMCossh,
-          default => openssh
-        }
-
-        # Use the alias to specify a dependency, rather than
-        # having another selector to figure it out again.
-        package { $ssh:
-          ensure => installed,
-          alias => openssh,
-          require => Package[openssl]
-        }
+      a common name to packages:
+
+          # In the 'openssl' class
+          $ssl = $operatingsystem ? {
+            solaris => SMCossl,
+            default => openssl
+          }
+
+          # It is not an error to set an alias to the same value as the
+          # object name.
+          package { $ssl:
+            ensure => installed,
+            alias => openssl
+          }
+
+          . etc. .
+
+          $ssh = $operatingsystem ? {
+            solaris => SMCossh,
+            default => openssh
+          }
+
+          # Use the alias to specify a dependency, rather than
+          # having another selector to figure it out again.
+          package { $ssh:
+            ensure => installed,
+            alias => openssh,
+            require => Package[openssl]
+          }
 
       "
       isnamevar
@@ -228,7 +227,7 @@ module Puppet
     end
 
     newparam(:type) do
-      desc "Deprecated form of ``provider``."
+      desc "Deprecated form of `provider`."
 
       munge do |value|
         warning "'type' is deprecated; use 'provider' instead"
@@ -243,7 +242,7 @@ module Puppet
         This is currently only used on Solaris.  The value will be
         validated according to system rules, which in the case of
         Solaris means that it should either be a fully qualified path
-        or it should be in /var/sadm/install/admin."
+        or it should be in `/var/sadm/install/admin`."
     end
 
     newparam(:responsefile) do
@@ -320,4 +319,3 @@ module Puppet
     end
   end
 end
-