From c158a0fec67b571eb9445a384e2cb1689e47db87 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Rapha=C3=ABl=20Pinson?= <raphael.pinson@camptocamp.com>
Date: Mon, 26 Mar 2012 09:46:22 +0200
Subject: Add doc for augeas::lens

---
 manifests/lens.pp | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

(limited to 'manifests')

diff --git a/manifests/lens.pp b/manifests/lens.pp
index 109dd38..c2bcd46 100644
--- a/manifests/lens.pp
+++ b/manifests/lens.pp
@@ -1,3 +1,24 @@
+/*
+
+== 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.
+
+Example usage:
+
+  augeas::lens { "networkmanager":
+    lens_source => "puppet:///modules/networkmanager/lenses/networkmanager.aug",
+    test_source => "puppet:///modules/networkmanager/lenses/test_networkmanager.aug",
+  }
+
+*/
+
 define augeas::lens (
   $ensure=present,
   $lens_source,
-- 
cgit v1.2.3