From de7690c4e76ddd7c1f01d81fe92c75771da47c51 Mon Sep 17 00:00:00 2001
From: David Schmitt <david@dasz.at>
Date: Tue, 9 Jun 2009 17:51:10 +0200
Subject: RDoc-ify documentation

See http://club.black.co.at/david/puppet/doc/ for a current version of the RDoc
output.
---
 manifests/defines/line.pp | 40 +++++++++++++++++++++-------------------
 1 file changed, 21 insertions(+), 19 deletions(-)

(limited to 'manifests/defines/line.pp')

diff --git a/manifests/defines/line.pp b/manifests/defines/line.pp
index fe2124d..be5ec31 100644
--- a/manifests/defines/line.pp
+++ b/manifests/defines/line.pp
@@ -2,36 +2,38 @@
 # Copyright (C) 2007 David Schmitt <david@schmitt.edv-bus.at>
 # See LICENSE for the full license granted to you.
 
-# Ensures that a specific line is present or absent in a file. This can be very
-# brittle, since even small changes can throw this off.
+# Ensures that a specific line is present or absent in a file. This can
+# be very brittle, since even small changes can throw this off.
 #
 # If the line is not present yet, it will be appended to the file.
 # 
 # The name of the define is not used. Just keep it (globally) unique and
 # descriptive.
 #
-# Use this only for very trivial stuff.
+# Use this only for very trivial stuff. Usually replacing the whole file
+# is a more stable solution with less maintenance headaches afterwards.
 #
 # Usage:
-# line { description:
-# 	file => "filename",
-# 	line => "content",
-# 	ensure => {absent,*present*}
-# }
+#  line {
+#  	description:
+# 			file => "filename",
+#  		line => "content",
+# 			ensure => {absent,*present*}
+#  }
 #
 # Example:
-# The following ensures that the line "allow ^$munin_host$" exists
-# in /etc/munin/munin-node.conf, and if there are any changes notify the service for
-# a restart
-#
-# line { allow_munin_host:
-#       file => "/etc/munin/munin-node.conf",
-#       line => "allow ^$munin_host$",
-#       ensure => present,
-#       notify => Service[munin-node],
-#       require => Package[munin-node],
-# }
+# The following ensures that the line "allow ^$munin_host$" exists in
+# /etc/munin/munin-node.conf, and if there are any changes notify the
+# service for a restart
 #
+#  line {
+#  	allow_munin_host:
+#  		file => "/etc/munin/munin-node.conf",
+#  		line => "allow ^$munin_host$",
+#  		ensure => present,
+#  		notify => Service[munin-node],
+#  		require => Package[munin-node];
+#  }
 define line(
 	$file,
 	$line,
-- 
cgit v1.2.3