summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorintrigeri <intrigeri@boum.org>2016-06-29 18:49:23 +0000
committerintrigeri <intrigeri@boum.org>2016-06-29 18:49:23 +0000
commit13cb9fb48538fc7eed9b2f924aa4c84dd1434e3b (patch)
tree77da2a586545f9c803640aa7c18adc2675af7387
parent92e7d506c0d570ce0d6eabc9492a785c94156cf2 (diff)
Move documentation to README, and expand a bit on it.
-rw-r--r--README.md5
-rw-r--r--manifests/dist_upgrade.pp2
2 files changed, 5 insertions, 2 deletions
diff --git a/README.md b/README.md
index c0d5f85..185efb0 100644
--- a/README.md
+++ b/README.md
@@ -356,6 +356,11 @@ classes may inherit from this one and add to its subscription list
using the plusignment (`+>`) operator. A real-world example can be
seen in the `apt::dist_upgrade::initiator` source.
+Parameters:
+
+ * timeout: specified in seconds; the maximum time the `dist-upgrade`
+ command should take. If the command takes longer than the timeout,
+ the command is considered to have failed and will be stopped.
## apt::dist_upgrade::initiator<a name="apt-dist_upgrade-initiator"></a>
diff --git a/manifests/dist_upgrade.pp b/manifests/dist_upgrade.pp
index e5475fc..3061fb8 100644
--- a/manifests/dist_upgrade.pp
+++ b/manifests/dist_upgrade.pp
@@ -1,5 +1,3 @@
-# Parameters:
-# - timeout: specified in seconds
class apt::dist_upgrade (
$timeout = 300,
) {