Move documentation to README, and expand a bit on it.
This commit is contained in:
parent
92e7d506c0
commit
13cb9fb485
2 changed files with 5 additions and 2 deletions
|
@ -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>
|
||||
|
||||
|
|
|
@ -1,5 +1,3 @@
|
|||
# Parameters:
|
||||
# - timeout: specified in seconds
|
||||
class apt::dist_upgrade (
|
||||
$timeout = 300,
|
||||
) {
|
||||
|
|
Loading…
Reference in a new issue