X-Git-Url: https://review.fuel-infra.org/gitweb?a=blobdiff_plain;f=manifests%2Fsetting.pp;h=6757f612260f6e59d5bc53afcc60ba9deedc612b;hb=d3aea9c076a89a48704742562e90b7f8f9f9aa18;hp=dcf082e095609c7b902fb0c6d46e6acafc495e0c;hpb=65904b214d98c899f390ac6908322fc06e3aca13;p=puppet-modules%2Fpuppetlabs-apt.git

diff --git a/manifests/setting.pp b/manifests/setting.pp
index dcf082e..6757f61 100644
--- a/manifests/setting.pp
+++ b/manifests/setting.pp
@@ -1,4 +1,24 @@
-# Defining apt settings
+# @summary Manages Apt configuration files.
+#
+# @see https://docs.puppetlabs.com/references/latest/type.html#file-attributes for more information on source and content parameters
+#
+# @param priority
+#   Determines the order in which Apt processes the configuration file. Files with higher priority numbers are loaded first.
+#
+# @param ensure
+#   Specifies whether the file should exist. Valid options: 'present', 'absent', and 'file'.
+#
+# @param source
+#   Required, unless `content` is set. Specifies a source file to supply the content of the configuration file. Cannot be used in combination 
+#   with `content`. Valid options: see link above for Puppet's native file type source attribute.
+#
+# @param content
+#   Required, unless `source` is set. Directly supplies content for the configuration file. Cannot be used in combination with `source`. Valid 
+#   options: see link above for Puppet's native file type content attribute.
+#
+# @param notify_update
+#   Specifies whether to trigger an `apt-get update` run.
+#
 define apt::setting (
   Variant[String, Integer, Array] $priority           = 50,
   Optional[Enum['file', 'present', 'absent']] $ensure = file,
@@ -8,11 +28,11 @@ define apt::setting (
 ) {
 
   if $content and $source {
-    fail(translate('apt::setting cannot have both content and source'))
+    fail('apt::setting cannot have both content and source')
   }
 
   if !$content and !$source {
-    fail(translate('apt::setting needs either of content or source'))
+    fail('apt::setting needs either of content or source')
   }
 
   $title_array = split($title, '-')
@@ -20,13 +40,13 @@ define apt::setting (
   $base_name = join(delete_at($title_array, 0), '-')
 
   assert_type(Pattern[/\Aconf\z/, /\Apref\z/, /\Alist\z/], $setting_type) |$a, $b| {
-    fail(translate("apt::setting resource name/title must start with either 'conf-', 'pref-' or 'list-'"))
+    fail("apt::setting resource name/title must start with either 'conf-', 'pref-' or 'list-'")
   }
 
   if $priority !~ Integer {
     # need this to allow zero-padded priority.
     assert_type(Pattern[/^\d+$/], $priority) |$a, $b| {
-      fail(translate('apt::setting priority must be an integer or a zero-padded integer'))
+      fail('apt::setting priority must be an integer or a zero-padded integer')
     }
   }
 
@@ -49,7 +69,6 @@ define apt::setting (
     ensure  => $ensure,
     owner   => 'root',
     group   => 'root',
-    mode    => '0644',
     content => $content,
     source  => $source,
     notify  => $_notify,