Merge pull request #795 from eimlav/modules3307

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

diff --git a/manifests/ppa.pp b/manifests/ppa.pp
index 1559e00503980106c1d5fd0b4376c5111d8aef2a..402961a72a949631b9ba6ebaed7b104abefdefca 100644 (file)
--- a/manifests/ppa.pp
+++ b/manifests/ppa.pp
@@ -1,4 +1,24 @@
-# ppa.pp
+# @summary Manages PPA repositories using `add-apt-repository`. Not supported on Debian.
+#
+# @example Example declaration of an Apt PPA
+#   apt::ppa{ 'ppa:openstack-ppa/bleeding-edge': }
+#
+# @param ensure
+#   Specifies whether the PPA should exist. Valid options: 'present' and 'absent'. 
+#
+# @param options
+#   Supplies options to be passed to the `add-apt-repository` command. Default: '-y'.
+#
+# @param release
+#   Optional if lsb-release is installed (unless you're using a different release than indicated by lsb-release, e.g., Linux Mint). 
+#   Specifies the operating system of your node. Valid options: a string containing a valid LSB distribution codename.
+#
+# @param package_name
+#   Names the package that provides the `apt-add-repository` command. Default: 'software-properties-common'.
+#
+# @param package_manage
+#   Specifies whether Puppet should manage the package that provides `apt-add-repository`.
+#
 define apt::ppa(
   String $ensure                 = 'present',
   Optional[String] $options      = $::apt::ppa_options,