(CONT-1001) Add litmus ~> 1.0

[puppet-modules/puppetlabs-apt.git] / manifests / pin.pp

diff --git a/manifests/pin.pp b/manifests/pin.pp
index 831d75f03b50b6c4b41215ae71dfeae534910fc3..bd8b470b1710160879bbeb7e3e9c7bd9e99d1720 100644 (file)
--- a/manifests/pin.pp
+++ b/manifests/pin.pp
@@ -1,22 +1,62 @@
-# pin.pp
-# pin a release in apt, useful for unstable repositories
-
-define apt::pin(
-  Optional[Enum['file', 'present', 'absent']] $ensure = present,
-  Optional[String] $explanation                       = undef,
-  Variant[Integer] $order                             = 50,
-  Variant[String, Array] $packages                    = '*',
-  Variant[Numeric, String] $priority                  = 0,
-  Optional[String] $release                           = '', # a=
-  Optional[String] $origin                            = '',
-  Optional[String] $version                           = '',
-  Optional[String] $codename                          = '', # n=
-  Optional[String] $release_version                   = '', # v=
-  Optional[String] $component                         = '', # c=
-  Optional[String] $originator                        = '', # o=
-  Optional[String] $label                             = '',  # l=
+# @summary Manages Apt pins. Does not trigger an apt-get update run.
+#
+# @see http://linux.die.net/man/5/apt_preferences for context on these parameters
+#
+# @param ensure
+#   Specifies whether the pin should exist. Valid options: 'file', 'present', and 'absent'.
+#
+# @param explanation
+#   Supplies a comment to explain the pin. Default: "${caller_module_name}: ${name}".
+#
+# @param order
+#   Determines the order in which Apt processes the pin file. Files with lower order numbers are loaded first.
+#
+# @param packages
+#   Specifies which package(s) to pin.
+#
+# @param priority
+#   Sets the priority of the package. If multiple versions of a given package are available, `apt-get` installs the one with the highest 
+#   priority number (subject to dependency constraints). Valid options: an integer.
+#
+# @param release
+#   Tells APT to prefer packages that support the specified release. Typical values include 'stable', 'testing', and 'unstable'.
+#
+# @param release_version
+#   Tells APT to prefer packages that support the specified operating system release version (such as Debian release version 7).
+#
+# @param component
+#   Names the licensing component associated with the packages in the directory tree of the Release file.
+#
+# @param originator
+#   Names the originator of the packages in the directory tree of the Release file.
+#
+# @param label
+#   Names the label of the packages in the directory tree of the Release file.
+#
+# @param origin
+#   The package origin
+#
+# @param version
+#   The version of the package
+#
+# @param codename
+#   The codename of the package
+#
+define apt::pin (
+  Enum['file', 'present', 'absent'] $ensure = present,
+  Optional[String] $explanation             = undef,
+  Variant[Integer] $order                   = 50,
+  Variant[String, Array] $packages          = '*',
+  Variant[Numeric, String] $priority        = 0,
+  Optional[String] $release                 = undef, # a=
+  Optional[String] $origin                  = undef,
+  Optional[String] $version                 = undef,
+  Optional[String] $codename                = undef, # n=
+  Optional[String] $release_version         = undef, # v=
+  Optional[String] $component               = undef, # c=
+  Optional[String] $originator              = undef, # o=
+  Optional[String] $label                   = undef,  # l=
 ) {
-
   if $explanation {
     $_explanation = $explanation
   } else {
@@ -47,15 +87,15 @@ define apt::pin(
   }
 
   if $packages_string != '*' { # specific form
-    if ( $pin_release != '' and ( $origin != '' or $version != '' )) or
-      ( $version != '' and ( $pin_release != '' or $origin != '' )) {
+    if ( $pin_release != '' and ( $origin or $version )) or
+    ( $version and ( $pin_release != '' or $origin )) {
       fail('parameters release, origin, and version are mutually exclusive')
     }
   } else { # general form
-    if $version != '' {
+    if $version {
       fail('parameter version cannot be used in general form')
     }
-    if ( $pin_release != '' and $origin != '' ) {
+    if ( $pin_release != '' and $origin ) {
       fail('parameters release and origin are mutually exclusive')
     }
   }