X-Git-Url: https://review.fuel-infra.org/gitweb?a=blobdiff_plain;f=manifests%2Fpin.pp;h=c8a45e9d2f36535f1168a3a6d00f857d457ee229;hb=f837fd29667f46e8d729198291c98f5b1ac171af;hp=ee32de4694a5a50c7dda1cd48f89c8c1de214da7;hpb=4815fa1f5482814e1d1a7e1626277aa35e3fc67c;p=puppet-modules%2Fpuppetlabs-apt.git

diff --git a/manifests/pin.pp b/manifests/pin.pp
index ee32de4..c8a45e9 100644
--- a/manifests/pin.pp
+++ b/manifests/pin.pp
@@ -1,8 +1,40 @@
-# pin.pp
-# pin a release in apt, useful for unstable repositories
-
-define apt::pin(
-  Optional[Enum['file', 'present', 'absent']] $ensure = present,
+# @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 (
+  Enum['file', 'present', 'absent'] $ensure           = present,
   Optional[String] $explanation                       = undef,
   Variant[Integer] $order                             = 50,
   Variant[String, Array] $packages                    = '*',
@@ -16,7 +48,6 @@ define apt::pin(
   Optional[String] $originator                        = '', # o=
   Optional[String] $label                             = '',  # l=
 ) {
-
   if $explanation {
     $_explanation = $explanation
   } else {
@@ -40,7 +71,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