summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorintrigeri <intrigeri@boum.org>2016-06-29 18:45:32 +0000
committerintrigeri <intrigeri@boum.org>2016-06-29 18:45:32 +0000
commitc439b8a524fc8f797e98b2c5351b028cf91ce237 (patch)
treea51a04b7fb54776f32547e2dc81039de7ecd006a /README.md
parentf035fd1621c8f0fa5eeeacd89ba52742c540cb7c (diff)
Remove documentation for apt::cron::download, and document the new parameter to apt::cron::dist_upgrade.
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 5 insertions, 16 deletions
diff --git a/README.md b/README.md
index 2173d7e..2028e2a 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,6 @@
* [Classes](#classes)
* [apt](#apt)
* [apt::apticron](#apt-apticron)
- * [apt::cron::download](#apt-cron-download)
* [apt::cron::dist_upgrade](#apt-cron-dist_upgrade)
* [apt::dist_upgrade](#apt-dist_upgrade)
* [apt::dist_upgrade::initiator](#apt-dist_upgrade-initiator)
@@ -324,30 +323,20 @@ Example usage:
}
-## apt::cron::download<a name="apt-cron-download"></a>
+## apt::cron::dist_upgrade<a name="apt-cron-dist_upgrade"></a>
-This class sets up `cron-apt` so that it downloads upgradable packages, does not
-actually do any upgrade and emails when the output changes.
+This class sets up cron-apt so that it dist-upgrades the system and
+emails when upgrades are performed.
`cron-apt` defaults to run at 4 AM. You may want to set the
-`$apt_cron_hours` variable before you include the class: its value will
+`$cron_hours` class parameter before you include the class: its value will
be passed as the "hours" parameter of a cronjob. Example:
# Run cron-apt every three hours
- $apt_cron_hours = '*/3'
+ class { 'apt::cron::dist_upgrade': cron_hours => '*/3' }
Note that the default 4 AM cronjob won't be disabled.
-
-## apt::cron::dist_upgrade<a name="apt-cron-dist_upgrade"></a>
-
-This class sets up cron-apt so that it dist-upgrades the system and
-emails when upgrades are performed.
-
-See [apt::cron::download](#apt-cron-download) above if you need to run `cron-apt` more often
-than once a day.
-
-
## apt::dist_upgrade<a name="apt-dist_upgrade"></a>
This class provides the `Exec['apt_dist-upgrade']` resource that