From ded140e36a02a9c4da7230a836cec0242179c84e Mon Sep 17 00:00:00 2001
From: Gareth Rushgrove <gareth@morethanseven.net>
Date: Tue, 26 Nov 2013 10:06:42 +0000
Subject: [PATCH] a whole bunch of lint and style fixes

---
 README.md            |  4 ++--
 manifests/config.pp  |  2 ++
 manifests/image.pp   | 43 ++++++++++++++++++++++++++++++-------------
 manifests/install.pp |  4 ++--
 manifests/params.pp  |  4 ++++
 manifests/run.pp     |  4 ++++
 manifests/service.pp | 14 ++++++++++++++
 7 files changed, 58 insertions(+), 17 deletions(-)

diff --git a/README.md b/README.md
index ae99005..b220651 100644
--- a/README.md
+++ b/README.md
@@ -64,8 +64,8 @@ You can also remove images you no longer need with:
     }
 
     docker::image { 'ubuntu':
-      ensure  => 'absent',
-      image_tag     => 'precise'
+      ensure    => 'absent',
+      image_tag => 'precise'
     }
 
 ### Containers
diff --git a/manifests/config.pp b/manifests/config.pp
index 0fd3721..9b7ea1c 100644
--- a/manifests/config.pp
+++ b/manifests/config.pp
@@ -1,2 +1,4 @@
+# == Class: docker::config
+#
 class docker::config {
 }
diff --git a/manifests/image.pp b/manifests/image.pp
index e06670f..b686f61 100644
--- a/manifests/image.pp
+++ b/manifests/image.pp
@@ -1,22 +1,39 @@
+# == Class: docker
+#
+# Module to install an up-to-date version of Docker from the
+# official Apt repository. The use of this repository means, this module works
+# only on Debian based distributions.
+#
+# === Parameters
+# [*ensure*]
+#   Whether you want the image present or absent.
+#
+# [*image*]
+#   If you want the name of the image to be different from the
+#   name of the puppet resource you can pass a value here.
+#
+# [*image_tag*]
+#   If you want a specific tag of the image to be installed
+#
+#
 define docker::image(
-  $ensure = 'present',
-  $image  = $title,
-  $image_tag    = undef
+  $ensure    = 'present',
+  $image     = $title,
+  $image_tag = undef
 ) {
 
   validate_re($ensure, '^(present|absent)$')
   validate_re($image, '^[\S]*$')
 
-    if $image_tag {
-      $image_install = "docker pull -t=\"${image_tag}\" ${image}"
-      $image_remove  = "docker rmi ${image}:${image_tag}"
-      $image_find    = "docker images | grep ^${image} | awk '{ print \$2 }' | grep ${image_tag}"
-    } else {
-      $image_install = "docker pull ${image}"
-      $image_remove  = "docker rmi ${image}"
-      $image_find    = "docker images | grep ^${image}"
-    }
-
+  if $image_tag {
+    $image_install = "docker pull -t=\"${image_tag}\" ${image}"
+    $image_remove  = "docker rmi ${image}:${image_tag}"
+    $image_find    = "docker images | grep ^${image} | awk '{ print \$2 }' | grep ${image_tag}"
+  } else {
+    $image_install = "docker pull ${image}"
+    $image_remove  = "docker rmi ${image}"
+    $image_find    = "docker images | grep ^${image}"
+  }
 
   if $ensure == 'absent' {
     exec { $image_remove:
diff --git a/manifests/install.pp b/manifests/install.pp
index 9541e72..d806b5c 100644
--- a/manifests/install.pp
+++ b/manifests/install.pp
@@ -48,11 +48,11 @@ class docker::install {
   if $docker::version {
     $dockerpackage = "lxc-docker-${docker::version}"
   } else {
-    $dockerpackage = "lxc-docker"
+    $dockerpackage = 'lxc-docker'
   }
 
   package { 'lxc-docker':
-    name   => $dockerpackage,
     ensure => $docker::ensure,
+    name   => $dockerpackage,
   }
 }
diff --git a/manifests/params.pp b/manifests/params.pp
index 8fbf0a4..9ff703f 100644
--- a/manifests/params.pp
+++ b/manifests/params.pp
@@ -1,3 +1,7 @@
+# == Class: docker::paramrs
+#
+# Defaut parameter values for the docker module
+#
 class docker::params {
   $version                 = undef
   $ensure                  = present
diff --git a/manifests/run.pp b/manifests/run.pp
index 3c511d2..77061d9 100644
--- a/manifests/run.pp
+++ b/manifests/run.pp
@@ -1,3 +1,7 @@
+# == Define: docker:run
+#
+# A define which manages an upstart managed docker container
+#
 define docker::run(
   $image,
   $command,
diff --git a/manifests/service.pp b/manifests/service.pp
index 639375f..b6aac8b 100644
--- a/manifests/service.pp
+++ b/manifests/service.pp
@@ -1,3 +1,17 @@
+# == Class: docker::service
+#
+# Class to manage the docker service daemon
+#
+# === Parameters
+# [*tcp_bind*]
+#   Which tcp port, if any, to bind the docker service to.
+#
+# [*socket_bind*]
+#   Which local unix socket to bind the docker service to.
+#
+# [*root_dir*]
+#   Specify a non-standard root directory for docker.
+#
 class docker::service (
   $tcp_bind             = $docker::tcp_bind,
   $socket_bind          = $docker::socket_bind,