Apply remaining rubocop fixes
[puppet-modules/puppetlabs-apt.git] / manifests / backports.pp
index 1b9cabbaf10ff062d868f86f4dd6331380ee5b4b..21f1251ea75a23987b94614080c2f96922702c47 100644 (file)
@@ -1,7 +1,7 @@
 # @summary Manages backports.
 #
-# @example Set up a backport for linuxmint qiana
-#   apt::backports { 'qiana':
+# @example Set up a backport source for Linux Mint qiana
+#   class { 'apt::backports':
 #     location => 'http://us.archive.ubuntu.com/ubuntu',
 #     release  => 'trusty-backports',
 #     repos    => 'main universe multiverse restricted',
 #   Specifies a pin priority for the backports. Valid options: a number or string to be passed to the `id` parameter of the `apt::pin` defined 
 #   type, or a hash of `parameter => value` pairs to be passed to `apt::pin`'s corresponding parameters.
 #
+# @param include
+#   Specifies whether to include 'deb' or 'src', or both.
+#
 class apt::backports (
   Optional[String] $location                    = undef,
   Optional[String] $release                     = undef,
   Optional[String] $repos                       = undef,
   Optional[Variant[String, Hash]] $key          = undef,
   Optional[Variant[Integer, String, Hash]] $pin = 200,
+  Optional[Variant[Hash]] $include              = {},
 ){
 
   include apt
@@ -102,6 +106,7 @@ class apt::backports (
     location => $_location,
     release  => $_release,
     repos    => $_repos,
+    include  => $include,
     key      => $_key,
     pin      => $_pin,
   }