summaryrefslogtreecommitdiff
path: root/manifests/README.markdown
diff options
context:
space:
mode:
Diffstat (limited to 'manifests/README.markdown')
-rw-r--r--manifests/README.markdown28
1 files changed, 28 insertions, 0 deletions
diff --git a/manifests/README.markdown b/manifests/README.markdown
new file mode 100644
index 0000000..bbf645a
--- /dev/null
+++ b/manifests/README.markdown
@@ -0,0 +1,28 @@
+Manifests
+=========
+
+Module manifest files belong in this directory.
+
+`init.pp` defines how the module will carry out its tasks in this file.
+
+Add additional definitions in this directory. Their file paths should match the
+definition name; for example, a definition `mydefinition`, defined like this:
+
+ # Definition: mydefinition
+ #
+ # This is the mydefinition in the mymodule module.
+ #
+ # Parameters:
+ #
+ # Actions:
+ #
+ # Requires:
+ #
+ # Sample Usage:
+ #
+ # [Remember: No empty lines between comments and class definition]
+ define mydefinition {
+ # ...
+ }
+
+Should be found in `mydefinition.pp` in this directory.