Permalink
Browse files

Added puppet docs to all classes

  • Loading branch information...
1 parent 82f98e2 commit bd877dec0ce5507e6db2a421079c55a3a1d71220 @vStone vStone committed Mar 4, 2012
Showing with 48 additions and 0 deletions.
  1. +5 −0 manifests/init.pp
  2. +5 −0 manifests/install.pp
  3. +18 −0 manifests/params.pp
  4. +20 −0 manifests/repo.pp
View
@@ -1,3 +1,8 @@
+# =Class: git
+#
+# Sets up requirements for git. See git::repo for more information on how to
+# use this module.
+#
class git {
include git::install
}
View
@@ -1,3 +1,8 @@
+# = Class: git::install
+#
+# Installs required packages for git.
+#
+#
class git::install {
require git::params
View
@@ -1,3 +1,21 @@
+# = Class: git::params
+#
+# Configure how the puppet git module behaves
+#
+# == Parameters:
+#
+# $bin:: Path to git. Defaults to /usr/bin/git.
+#
+# $package:: Override the name of the git package(s) to include.
+#
+# == Usage:
+#
+# Example: Override the path to the git binary.
+#
+# class {'git::params':
+# bin => '/usr/local/bin/git',
+# }
+#
class git::params (
$bin = '/usr/bin/git',
$package = undef
View
@@ -1,3 +1,23 @@
+# = Definition: git::repo
+#
+# == Parameters:
+#
+# $target:: Target folder. Required.
+#
+# $bare:: Create a bare repository. Defaults to false.
+#
+# $source:: Source to clone from. If not specified, no remote will be used.
+#
+# $user:: Owner of the repository. Defaults to root.
+#
+# == Usage:
+#
+# git::repo {'mygit':
+# target => '/home/user/puppet-git',
+# source => 'git://github.com/theforeman/puppet-git.git',
+# user => 'user',
+# }
+#
define git::repo (
$target,
$bare = false,

0 comments on commit bd877de

Please sign in to comment.