summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormh <mh@immerda.ch>2013-02-27 23:11:16 +0100
committermh <mh@immerda.ch>2013-02-27 23:11:16 +0100
commitd1f779045d05f607124032636a1da594ed250cab (patch)
tree0dce18d57fdd916ed80f8ef76315db4d9fa316a5
parente8942ebce272e20674cdf4ec64261484c34129ed (diff)
linting documentation
-rw-r--r--manifests/base.pp1
-rw-r--r--manifests/debian.pp1
-rw-r--r--manifests/init.pp1
-rw-r--r--manifests/lens.pp45
-rw-r--r--manifests/redhat.pp1
5 files changed, 24 insertions, 25 deletions
diff --git a/manifests/base.pp b/manifests/base.pp
index 57102ec..0db9b50 100644
--- a/manifests/base.pp
+++ b/manifests/base.pp
@@ -1,3 +1,4 @@
+# basic things to manage augeas
class augeas::base {
# ensure no file not managed by puppet ends up in there.
file { $augeas::lens_dir:
diff --git a/manifests/debian.pp b/manifests/debian.pp
index 4f5783d..5bc1bb5 100644
--- a/manifests/debian.pp
+++ b/manifests/debian.pp
@@ -1,3 +1,4 @@
+# manage debian specific things
class augeas::debian inherits augeas::base {
package {
diff --git a/manifests/init.pp b/manifests/init.pp
index 831bd14..3a26a24 100644
--- a/manifests/init.pp
+++ b/manifests/init.pp
@@ -1,3 +1,4 @@
+# Basic class to manage augeas
class augeas(
$version = 'installed',
$rubylib_version = 'installed',
diff --git a/manifests/lens.pp b/manifests/lens.pp
index 59746e7..81ec6fd 100644
--- a/manifests/lens.pp
+++ b/manifests/lens.pp
@@ -1,28 +1,23 @@
-/*
-
-== Definition: augeas::lens
-
-Deploy an Augeas lens (and its test file).
-Check the lens (and run the unit tests) automatically and remove the files if
-the checks fail.
-
-Parameters:
-- *ensure*: present/absent
-- *lens_source*: the source for the lens
-- *test_source*: optionally, the source for the test file.
-- *stock_since*: optionally, indicate in which version of Augeas
- the lens became stock, so it will not be deployed above that version.
-
-Example usage:
-
- augeas::lens { 'networkmanager':
- lens_source => 'puppet:///modules/networkmanager/lenses/networkmanager.aug',
- test_source => 'puppet:///modules/networkmanager/lenses/test_networkmanager.aug',
- stock_since => '1.0.0',
- }
-
-*/
-
+# == Definition: augeas::lens
+#
+# Deploy an Augeas lens (and its test file).
+# Check the lens (and run the unit tests) automatically and remove the files if
+# the checks fail.
+#
+# Parameters:
+# - *ensure*: present/absent
+# - *lens_source*: the source for the lens
+# - *test_source*: optionally, the source for the test file.
+# - *stock_since*: optionally, indicate in which version of Augeas
+# the lens became stock, so it will not be deployed above that version.
+#
+# Example usage:
+#
+# augeas::lens { 'networkmanager':
+# lens_source => 'puppet:///modules/networkmanager/lenses/networkmanager.aug',
+# test_source => 'puppet:///modules/networkmanager/lenses/test_networkmanager.aug',
+# stock_since => '1.0.0',
+# }
define augeas::lens (
$lens_source,
$ensure=present,
diff --git a/manifests/redhat.pp b/manifests/redhat.pp
index c165566..23974e6 100644
--- a/manifests/redhat.pp
+++ b/manifests/redhat.pp
@@ -1,3 +1,4 @@
+# manage things for redhat based things
class augeas::redhat inherits augeas::base {
package {