summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authornfagerlund <nick.fagerlund@gmail.com>2011-08-17 15:09:03 -0700
committernfagerlund <nick.fagerlund@gmail.com>2011-08-18 12:39:04 -0700
commitfa2fde6635042cca38ec6f42b93faafda54d41cd (patch)
tree0f90ea5d08a46865590b2d4c4a78390d8f20f874
parent0594aa9141397bcc47f66f67698dad0790c4b9d4 (diff)
Docs: Update documentation of stdlib classes
This commit edits the puppetdoc text of the stdlib and stdlib::stages classes to remove redundancy and add additional information.
-rw-r--r--manifests/init.pp12
-rw-r--r--manifests/stages.pp11
2 files changed, 13 insertions, 10 deletions
diff --git a/manifests/init.pp b/manifests/init.pp
index c804568..500ad77 100644
--- a/manifests/init.pp
+++ b/manifests/init.pp
@@ -1,16 +1,18 @@
# Class: stdlib
#
-# This module manages stdlib
+# This module manages stdlib. Most of stdlib's features are automatically
+# loaded by Puppet, but this class should be declared in order to use the
+# standardized run stages.
#
-# Parameters:
+# Parameters: none
#
# Actions:
#
-# Requires:
+# Declares all other classes in the stdlib module. Currently, this consists
+# of stdlib::stages.
#
-# Sample Usage:
+# Requires: nothing
#
-# [Remember: No empty lines between comments and class definition]
class stdlib {
class { 'stdlib::stages': }
diff --git a/manifests/stages.pp b/manifests/stages.pp
index 365b905..eb15fd6 100644
--- a/manifests/stages.pp
+++ b/manifests/stages.pp
@@ -1,8 +1,9 @@
# Class: stdlib::stages
#
-# This class manages a standard set of Run Stages for Puppet.
+# This class manages a standard set of run stages for Puppet. It is managed by
+# the stdlib class, and should not be declared independently.
#
-# The high level stages are (In order):
+# The high level stages are (in order):
#
# * setup
# * main
@@ -13,19 +14,19 @@
# * deploy_app
# * deploy
#
-# Parameters:
+# Parameters: none
#
# Actions:
#
# Declares various run-stages for deploying infrastructure,
# language runtimes, and application layers.
#
-# Requires:
+# Requires: nothing
#
# Sample Usage:
#
# node default {
-# include stdlib::stages
+# include stdlib
# class { java: stage => 'runtime' }
# }
#