X-Git-Url: https://review.fuel-infra.org/gitweb?a=blobdiff_plain;f=manifests%2Fpin.pp;h=8145b7d4b6575c024c1435e803beb5ebda6ea334;hb=406efe9a8503b18001af8377c2cd2e315a7178e2;hp=ee32de4694a5a50c7dda1cd48f89c8c1de214da7;hpb=e9dadf5ed3308655d003374c4b2c2f5fe8619c27;p=puppet-modules%2Fpuppetlabs-apt.git

diff --git a/manifests/pin.pp b/manifests/pin.pp
index ee32de4..8145b7d 100644
--- a/manifests/pin.pp
+++ b/manifests/pin.pp
@@ -1,6 +1,38 @@
-# pin.pp
-# pin a release in apt, useful for unstable repositories
-
+# @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.
+#
 define apt::pin(
   Optional[Enum['file', 'present', 'absent']] $ensure = present,
   Optional[String] $explanation                       = undef,
@@ -40,7 +72,7 @@ define apt::pin(
   # Read the manpage 'apt_preferences(5)', especially the chapter
   # 'The Effect of APT Preferences' to understand the following logic
   # and the difference between specific and general form
-  if is_array($packages) {
+  if $packages =~ Array {
     $packages_string = join($packages, ' ')
   } else {
     $packages_string = $packages
@@ -49,14 +81,14 @@ define apt::pin(
   if $packages_string != '*' { # specific form
     if ( $pin_release != '' and ( $origin != '' or $version != '' )) or
       ( $version != '' and ( $pin_release != '' or $origin != '' )) {
-      fail('parameters release, origin, and version are mutually exclusive')
+      fail(translate('parameters release, origin, and version are mutually exclusive'))
     }
   } else { # general form
     if $version != '' {
-      fail('parameter version cannot be used in general form')
+      fail(translate('parameter version cannot be used in general form'))
     }
     if ( $pin_release != '' and $origin != '' ) {
-      fail('parameters release and origin are mutually exclusive')
+      fail(translate('parameters release and origin are mutually exclusive'))
     }
   }