X-Git-Url: https://review.fuel-infra.org/gitweb?a=blobdiff_plain;ds=sidebyside;f=README.md;h=1c9591dcb71779a26205661f2531cecf0a57a898;hb=800c8cc1b2e06d7e0a273d8b51a999da8dae7ecb;hp=4220775b990bea62f602b447ed5695955e4c359a;hpb=afa4d45ee904092ef17f4cb1a6189817819adc67;p=puppet-modules%2Fpuppetlabs-apt.git diff --git a/README.md b/README.md index 4220775..1c9591d 100644 --- a/README.md +++ b/README.md @@ -30,12 +30,12 @@ Apt (Advanced Package Tool) is a package manager available on Debian, Ubuntu, an ### What apt affects -* Your system's `preferences.list` file and `preferences.list.d` directory +* Your system's `preferences` file and `preferences.d` directory * Your system's `sources.list` file and `sources.list.d` directory * System repositories * Authentication keys -**Note:** This module offers `purge` parameters which, if set to 'true', **destroy** any configuration on the node's `sources.list(.d)` and `preferences.list(.d)` that you haven't declared through Puppet. The default for these parameters is 'false'. +**Note:** This module offers `purge` parameters which, if set to 'true', **destroy** any configuration on the node's `sources.list(.d)` and `preferences(.d)` that you haven't declared through Puppet. The default for these parameters is 'false'. ### Beginning with apt @@ -237,13 +237,15 @@ Main class, includes all other classes. * 'sources.list.d': Specifies whether to purge any unmanaged entries from `sources.list.d`. Valid options: 'true' and 'false'. Default: 'false'. - * 'preferences.list': Specifies whether to purge any unmanaged entries from `preferences.list`. Valid options: 'true' and 'false'. Default: 'false'. + * 'preferences': Specifies whether to purge any unmanaged entries from `preferences`. Valid options: 'true' and 'false'. Default: 'false'. - * 'preferences.list.d': Specifies whether to purge any unmanaged entries from `preferences.list.d`. Valid options: 'true' and 'false'. Default: 'false'. + * 'preferences.d': Specifies whether to purge any unmanaged entries from `preferences.d`. Valid options: 'true' and 'false'. Default: 'false'. * `settings`: Creates new `apt::setting` resources. Valid options: a hash to be passed to the [`create_resources` function](https://docs.puppetlabs.com/references/latest/function.html#createresources). Default: {}. -* `sources`: Creates new `apt::setting` resources. Valid options: a hash to be passed to the [`create_resources` function](https://docs.puppetlabs.com/references/latest/function.html#createresources). Default: {}. +* `sources`: Creates new `apt::source` resources. Valid options: a hash to be passed to the [`create_resources` function](https://docs.puppetlabs.com/references/latest/function.html#createresources). Default: {}. + +* `pins`: Creates new `apt::pin` resources. Valid options: a hash to be passed to the [`create_resources` function](https://docs.puppetlabs.com/references/latest/function.html#createresources). Default: {}. * `update`: Configures various update settings. Valid options: a hash made up from the following keys: @@ -291,6 +293,8 @@ Specifies a custom Apt configuration file. * `priority`: *Optional.* Determines the order in which Apt processes the configuration file. Files with lower priority numbers are loaded first. Valid options: a string containing an integer. Default: '50'. +* `notify_update`: *Optional.* Specifies whether to trigger an `apt-get update` run. Valid options: 'true' and 'false'. Default: 'true'. + #### Define: `apt::key` Manages the GPG keys that Apt uses to authenticate packages. @@ -323,7 +327,7 @@ The `apt::key` define makes use of the `apt_key` type, but includes extra functi #### Define: `apt::pin` -Manages Apt pins. +Manages Apt pins. Does not trigger an `apt-get update` run. **Note:** For context on these parameters, we recommend reading the man page ['apt_preferences(5)'](http://linux.die.net/man/5/apt_preferences)