puppet 2.7.6 → 2.7.8

data/lib/puppet/type/whit.rb

@@ -1,5 +1,9 @@
 Puppet::Type.newtype(:whit) do
-  desc "The smallest possible resource type, for when you need a resource and naught else."
+  desc "Whits are internal artifacts of Puppet's current implementation, and
+    Puppet suppresses their appearance in all logs. We make no guarantee of
+    the whit's continued existence, and it should never be used in an actual
+    manifest. Use the `anchor` type from the puppetlabs-stdlib module if you
+    need arbitrary whit-like no-op resources."
 
   newparam :name do
     desc "The name of the whit, because it must have one."
@@ -18,6 +22,6 @@ Puppet::Type.newtype(:whit) do
   def refresh
     # We don't do anything with them, but we need this to
     #   show that we are "refresh aware" and not break the
-    #   chain of propogation.
+    #   chain of propagation.
   end
 end

data/lib/puppet/type/yumrepo.rb

@@ -48,20 +48,20 @@ module Puppet
   end
 
   # Doc string for properties that can be made 'absent'
-  ABSENT_DOC="Set this to 'absent' to remove it from the file completely"
+  ABSENT_DOC="Set this to `absent` to remove it from the file completely."
 
   newtype(:yumrepo) do
     @doc = "The client-side description of a yum repository. Repository
       configurations are found by parsing `/etc/yum.conf` and
-      the files indicated by the `reposdir` option in that file 
-      (see yum.conf(5) for details)
+      the files indicated by the `reposdir` option in that file
+      (see `yum.conf(5)` for details).
 
       Most parameters are identical to the ones documented
-      in yum.conf(5)
+      in the `yum.conf(5)` man page.
 
-      Continuation lines that yum supports for example for the
-      baseurl are not supported. No attempt is made to access
-      files included with the **include** directive"
+      Continuation lines that yum supports (for the `baseurl`, for example)
+      are not supported. This type does not attempt to read or verify the
+      exinstence of files listed in the `include` attribute."
 
     class << self
       attr_accessor :filetype
@@ -200,13 +200,13 @@ module Puppet
 
     newparam(:name) do
       desc "The name of the repository.  This corresponds to the
-        repositoryid parameter in yum.conf(5)."
+        `repositoryid` parameter in `yum.conf(5)`."
       isnamevar
     end
 
     newproperty(:descr, :parent => Puppet::IniProperty) do
-      desc "A human readable description of the repository.
-        This corresponds to the name parameter in yum.conf(5).
+      desc "A human-readable description of the repository.
+        This corresponds to the name parameter in `yum.conf(5)`.
         #{ABSENT_DOC}"
       newvalue(:absent) { self.should = :absent }
       newvalue(/.*/) { }
@@ -222,37 +222,39 @@ module Puppet
     end
 
     newproperty(:baseurl, :parent => Puppet::IniProperty) do
-      desc "The URL for this repository.\n#{ABSENT_DOC}"
+      desc "The URL for this repository. #{ABSENT_DOC}"
       newvalue(:absent) { self.should = :absent }
       # Should really check that it's a valid URL
       newvalue(/.*/) { }
     end
 
     newproperty(:enabled, :parent => Puppet::IniProperty) do
-      desc "Whether this repository is enabled or disabled. Possible
-        values are '0', and '1'.\n#{ABSENT_DOC}"
+      desc "Whether this repository is enabled, as represented by a
+        `0` or `1`. #{ABSENT_DOC}"
       newvalue(:absent) { self.should = :absent }
       newvalue(%r{(0|1)}) { }
     end
 
     newproperty(:gpgcheck, :parent => Puppet::IniProperty) do
       desc "Whether to check the GPG signature on packages installed
-        from this repository. Possible values are '0', and '1'.
-        \n#{ABSENT_DOC}"
+        from this repository, as represented by a `0` or `1`.
+        #{ABSENT_DOC}"
       newvalue(:absent) { self.should = :absent }
       newvalue(%r{(0|1)}) { }
     end
 
     newproperty(:gpgkey, :parent => Puppet::IniProperty) do
       desc "The URL for the GPG key with which packages from this
-        repository are signed.\n#{ABSENT_DOC}"
+        repository are signed. #{ABSENT_DOC}"
       newvalue(:absent) { self.should = :absent }
       # Should really check that it's a valid URL
       newvalue(/.*/) { }
     end
 
     newproperty(:include, :parent => Puppet::IniProperty) do
-      desc "A URL from which to include the config.\n#{ABSENT_DOC}"
+      desc "The URL of a remote file containing additional yum configuration
+        settings. Puppet does not check for this file's existence or validity.
+        #{ABSENT_DOC}"
       newvalue(:absent) { self.should = :absent }
       # Should really check that it's a valid URL
       newvalue(/.*/) { }
@@ -269,41 +271,41 @@ module Puppet
     newproperty(:includepkgs, :parent => Puppet::IniProperty) do
       desc "List of shell globs. If this is set, only packages
         matching one of the globs will be considered for
-        update or install.\n#{ABSENT_DOC}"
+        update or install from this repo. #{ABSENT_DOC}"
       newvalue(:absent) { self.should = :absent }
       newvalue(/.*/) { }
     end
 
     newproperty(:enablegroups, :parent => Puppet::IniProperty) do
-      desc "Determines whether yum will allow the use of
-        package groups for this  repository. Possible
-        values are '0', and '1'.\n#{ABSENT_DOC}"
+      desc "Whether yum will allow the use of package groups for this
+        repository, as represented by a `0` or `1`. #{ABSENT_DOC}"
       newvalue(:absent) { self.should = :absent }
       newvalue(%r{(0|1)}) { }
     end
 
     newproperty(:failovermethod, :parent => Puppet::IniProperty) do
-      desc "Either 'roundrobin' or 'priority'.\n#{ABSENT_DOC}"
+      desc "The failover methode for this repository; should be either
+        `roundrobin` or `priority`. #{ABSENT_DOC}"
       newvalue(:absent) { self.should = :absent }
       newvalue(%r{roundrobin|priority}) { }
     end
 
     newproperty(:keepalive, :parent => Puppet::IniProperty) do
-      desc "Either '1' or '0'. This tells yum whether or not HTTP/1.1
-        keepalive  should  be  used with this repository.\n#{ABSENT_DOC}"
+      desc "Whether HTTP/1.1 keepalive should be used with this repository, as
+        represented by a `0` or `1`. #{ABSENT_DOC}"
       newvalue(:absent) { self.should = :absent }
       newvalue(%r{(0|1)}) { }
     end
 
      newproperty(:http_caching, :parent => Puppet::IniProperty) do
-       desc "Either 'packages' or 'all' or 'none'.\n#{ABSENT_DOC}" 
+       desc "What to cache from this repository. #{ABSENT_DOC}"
        newvalue(:absent) { self.should = :absent }
        newvalue(%r(packages|all|none)) { }
      end
 
     newproperty(:timeout, :parent => Puppet::IniProperty) do
       desc "Number of seconds to wait for a connection before timing
-        out.\n#{ABSENT_DOC}"
+        out. #{ABSENT_DOC}"
       newvalue(:absent) { self.should = :absent }
       newvalue(%r{[0-9]+}) { }
     end
@@ -317,7 +319,7 @@ module Puppet
 
     newproperty(:protect, :parent => Puppet::IniProperty) do
       desc "Enable or disable protection for this repository. Requires
-        that the protectbase plugin is installed and enabled.
+        that the `protectbase` plugin is installed and enabled.
         #{ABSENT_DOC}"
       newvalue(:absent) { self.should = :absent }
       newvalue(%r{(0|1)}) { }
@@ -325,7 +327,7 @@ module Puppet
 
     newproperty(:priority, :parent => Puppet::IniProperty) do
       desc "Priority of this repository from 1-99. Requires that
-        the priorities plugin is installed and enabled.
+        the `priorities` plugin is installed and enabled.
         #{ABSENT_DOC}"
       newvalue(:absent) { self.should = :absent }
       newvalue(%r{[1-9][0-9]?}) { }
@@ -338,20 +340,20 @@ module Puppet
     end
 
     newproperty(:proxy, :parent => Puppet::IniProperty) do
-      desc "URL to the proxy server for this repository.\n#{ABSENT_DOC}"
+      desc "URL to the proxy server for this repository. #{ABSENT_DOC}"
       newvalue(:absent) { self.should = :absent }
       # Should really check that it's a valid URL
       newvalue(/.*/) { }
     end
 
     newproperty(:proxy_username, :parent => Puppet::IniProperty) do
-      desc "Username for this proxy.\n#{ABSENT_DOC}"
+      desc "Username for this proxy. #{ABSENT_DOC}"
       newvalue(:absent) { self.should = :absent }
       newvalue(/.*/) { }
     end
 
     newproperty(:proxy_password, :parent => Puppet::IniProperty) do
-      desc "Password for this proxy.\n#{ABSENT_DOC}"
+      desc "Password for this proxy. #{ABSENT_DOC}"
       newvalue(:absent) { self.should = :absent }
       newvalue(/.*/) { }
     end

data/lib/puppet/type/zfs.rb

@@ -2,132 +2,134 @@ module Puppet
   newtype(:zfs) do
     @doc = "Manage zfs. Create destroy and set properties on zfs instances.
 
-**Autorequires:** If Puppet is managing the zpool at the root of this zfs instance, the zfs resource will autorequire it. If Puppet is managing any parent zfs instances, the zfs resource will autorequire them."
+**Autorequires:** If Puppet is managing the zpool at the root of this zfs
+instance, the zfs resource will autorequire it. If Puppet is managing any
+parent zfs instances, the zfs resource will autorequire them."
 
     ensurable
 
     newparam(:name) do
-      desc "The full name for this filesystem. (including the zpool)"
+      desc "The full name for this filesystem (including the zpool)."
     end
 
     newproperty(:aclinherit) do
-      desc "The aclinherit property. Values: discard | noallow | restricted | passthrough | passthrough-x"
+      desc "The aclinherit property. Valid values are `discard`, `noallow`, `restricted`, `passthrough`, `passthrough-x`."
     end
 
     newproperty(:aclmode) do
-      desc "The aclmode property. Values: discard | groupmask | passthrough"
+      desc "The aclmode property. Valid values are `discard`, `groupmask`, `passthrough`."
     end
 
     newproperty(:atime) do
-      desc "The atime property. Values: on | off"
+      desc "The atime property. Valid values are `on`, `off`."
     end
 
     newproperty(:canmount) do
-      desc "The canmount property. Values: on | off | noauto"
+      desc "The canmount property. Valid values are `on`, `off`, `noauto`."
     end
 
     newproperty(:checksum) do
-      desc "The checksum property. Values: on | off | fletcher2 | fletcher4 | sha256"
+      desc "The checksum property. Valid values are `on`, `off`, `fletcher2`, `fletcher4`, `sha256`."
     end
 
     newproperty(:compression) do
-      desc "The compression property. Values: on | off | lzjb | gzip | gzip-[1-9] | zle"
+      desc "The compression property. Valid values are `on`, `off`, `lzjb`, `gzip`, `gzip-[1-9]`, `zle`."
     end
 
     newproperty(:copies) do
-      desc "The copies property. Values: 1 | 2 | 3"
+      desc "The copies property. Valid values are `1`, `2`, `3`."
     end
 
     newproperty(:devices) do
-      desc "The devices property. Values: on | off"
+      desc "The devices property. Valid values are `on`, `off`."
     end
 
     newproperty(:exec) do
-      desc "The exec property. Values: on | off"
+      desc "The exec property. Valid values are `on`, `off`."
     end
 
     newproperty(:logbias) do
-      desc "The logbias property. Values: latency | throughput"
+      desc "The logbias property. Valid values are `latency`, `throughput`."
     end
 
     newproperty(:mountpoint) do
-      desc "The mountpoint property. Values: <path> | legacy | none"
+      desc "The mountpoint property. Valid values are `<path>`, `legacy`, `none`."
     end
 
     newproperty(:nbmand) do
-      desc "The nbmand property. Values: on | off"
+      desc "The nbmand property. Valid values are `on`, `off`."
     end
 
     newproperty(:primarycache) do
-      desc "The primarycache property. Values: all | none | metadata"
+      desc "The primarycache property. Valid values are `all`, `none`, `metadata`."
     end
 
     newproperty(:quota) do
-      desc "The quota property. Values: <size> | none"
+      desc "The quota property. Valid values are `<size>`, `none`."
     end
 
     newproperty(:readonly) do
-      desc "The readonly property. Values: on | off"
+      desc "The readonly property. Valid values are `on`, `off`."
     end
 
     newproperty(:recordsize) do
-      desc "The recordsize property. Values: 512 to 128k, power of 2"
+      desc "The recordsize property. Valid values are powers of two between 512 and 128k."
     end
 
     newproperty(:refquota) do
-      desc "The refquota property. Values: <size> | none"
+      desc "The refquota property. Valid values are `<size>`, `none`."
     end
 
     newproperty(:refreservation) do
-      desc "The refreservation property. Values: <size> | none"
+      desc "The refreservation property. Valid values are `<size>`, `none`."
     end
 
     newproperty(:reservation) do
-      desc "The reservation property. Values: <size> | none"
+      desc "The reservation property. Valid values are `<size>`, `none`."
     end
 
     newproperty(:secondarycache) do
-      desc "The secondarycache property. Values: all | none | metadata"
+      desc "The secondarycache property. Valid values are `all`, `none`, `metadata`."
     end
 
     newproperty(:setuid) do
-      desc "The setuid property. Values: on | off"
+      desc "The setuid property. Valid values are `on`, `off`."
     end
 
     newproperty(:shareiscsi) do
-      desc "The shareiscsi property. Values: on | off | type=<type>"
+      desc "The shareiscsi property. Valid values are `on`, `off`, `type=<type>`."
     end
 
     newproperty(:sharenfs) do
-      desc "The sharenfs property. Values: on | off | share(1M) options"
+      desc "The sharenfs property. Valid values are `on`, `off`, share(1M) options"
     end
 
     newproperty(:sharesmb) do
-      desc "The sharesmb property. Values: on | off | sharemgr(1M) options"
+      desc "The sharesmb property. Valid values are `on`, `off`, sharemgr(1M) options"
     end
 
     newproperty(:snapdir) do
-      desc "The snapdir property. Values: hidden | visible"
+      desc "The snapdir property. Valid values are `hidden`, `visible`."
     end
 
     newproperty(:version) do
-      desc "The version property. Values: 1 | 2 | 3 | 4 | current"
+      desc "The version property. Valid values are `1`, `2`, `3`, `4`, `current`."
     end
 
     newproperty(:volsize) do
-      desc "The volsize property. Values: <size>"
+      desc "The volsize property. Valid values are `<size>`"
     end
 
     newproperty(:vscan) do
-      desc "The vscan property. Values: on | off"
+      desc "The vscan property. Valid values are `on`, `off`."
     end
 
     newproperty(:xattr) do
-      desc "The xattr property. Values: on | off"
+      desc "The xattr property. Valid values are `on`, `off`."
     end
 
     newproperty(:zoned) do
-      desc "The zoned property. Values: on | off"
+      desc "The zoned property. Valid values are `on`, `off`."
     end
 
     autorequire(:zpool) do

data/lib/puppet/type/zone.rb

@@ -1,7 +1,9 @@
 Puppet::Type.newtype(:zone) do
-  @doc = "Solaris zones.
+  @doc = "Manages Solaris zones.
 
-**Autorequires:** If Puppet is managing the directory specified as the root of the zone's filesystem (with the `path` attribute), the zone resource will autorequire that directory."
+**Autorequires:** If Puppet is managing the directory specified as the root of
+the zone's filesystem (with the `path` attribute), the zone resource will
+autorequire that directory."
 
   # These properties modify the zone configuration, and they need to provide
   # the text separately from syncing it, so all config statements can be rolled
@@ -72,7 +74,7 @@ Puppet::Type.newtype(:zone) do
   ensurable do
     desc "The running state of the zone.  The valid states directly reflect
       the states that `zoneadm` provides.  The states are linear,
-      in that a zone must be `configured` then `installed`, and
+      in that a zone must be `configured`, then `installed`, and
       only then can be `running`.  Note also that `halt` is currently
       used to stop zones."
 
@@ -198,8 +200,8 @@ Puppet::Type.newtype(:zone) do
   newparam(:clone) do
     desc "Instead of installing the zone, clone it from another zone.
       If the zone root resides on a zfs file system, a snapshot will be
-      used to create the clone, is it redisides on ufs, a copy of the zone
-      will be used. The zone you clone from must not be running."
+      used to create the clone; if it resides on a ufs filesystem, a copy of the
+      zone will be used. The zone from which you clone must not be running."
   end
 
   newproperty(:ip, :parent => ZoneMultiConfigProperty) do
@@ -243,7 +245,7 @@ Puppet::Type.newtype(:zone) do
   end
 
   newproperty(:iptype, :parent => ZoneConfigProperty) do
-    desc "The IP stack type of the zone. Can either be 'shared' or 'exclusive'."
+    desc "The IP stack type of the zone."
 
     defaultto :shared
 
@@ -285,9 +287,9 @@ Puppet::Type.newtype(:zone) do
   end
 
   newproperty(:dataset, :parent => ZoneMultiConfigProperty) do
-    desc "The list of datasets delegated to the non global zone from the
-      global zone.  All datasets must be zfs filesystem names which is
-      different than the mountpoint." 
+    desc "The list of datasets delegated to the non-global zone from the
+      global zone.  All datasets must be zfs filesystem names which are
+      different from the mountpoint."
 
     validate do |value|
       unless value !~ /^\//
@@ -341,10 +343,10 @@ Puppet::Type.newtype(:zone) do
   # Specify the sysidcfg file.  This is pretty hackish, because it's
   # only used to boot the zone the very first time.
   newparam(:sysidcfg) do
-    desc %{The text to go into the sysidcfg file when the zone is first
+    desc %{The text to go into the `sysidcfg` file when the zone is first
       booted.  The best way is to use a template:
 
-          # $templatedir/sysidcfg
+          # $confdir/modules/site/templates/sysidcfg.erb
           system_locale=en_US
           timezone=GMT
           terminal=xterms
@@ -362,20 +364,20 @@ Puppet::Type.newtype(:zone) do
       And then call that:
 
           zone { myzone:
-            ip => "bge0:192.168.0.23",
-            sysidcfg => template(sysidcfg),
-            path => "/opt/zones/myzone",
+            ip           => "bge0:192.168.0.23",
+            sysidcfg     => template("site/sysidcfg.erb"),
+            path         => "/opt/zones/myzone",
             realhostname => "fully.qualified.domain.name"
           }
 
-      The sysidcfg only matters on the first booting of the zone,
+      The `sysidcfg` only matters on the first booting of the zone,
       so Puppet only checks for it at that time.}
   end
 
   newparam(:path) do
     desc "The root of the zone's filesystem.  Must be a fully qualified
-      file name.  If you include '%s' in the path, then it will be
-      replaced with the zone's name.  At this point, you cannot use
+      file name.  If you include `%s` in the path, then it will be
+      replaced with the zone's name.  Currently, you cannot use
       Puppet to move a zone."
 
     validate do |value|
@@ -394,11 +396,11 @@ Puppet::Type.newtype(:zone) do
   end
 
   newparam(:create_args) do
-    desc "Arguments to the zonecfg create command.  This can be used to create branded zones."
+    desc "Arguments to the `zonecfg` create command.  This can be used to create branded zones."
   end
 
   newparam(:install_args) do
-    desc "Arguments to the zoneadm install command.  This can be used to create branded zones."
+    desc "Arguments to the `zoneadm` install command.  This can be used to create branded zones."
   end
 
   newparam(:realhostname) do