From 2aafe6cbb2545528d19515b8ed91b8f0a9f97bd2 Mon Sep 17 00:00:00 2001
From: Branan Purvine-Riley <branan@puppetlabs.com>
Date: Thu, 18 Oct 2012 18:28:05 -0700
Subject: [PATCH] Improve documentation of the core apt class usage

---
 README.md | 135 ++++++++++++++++++++++++++++++------------------------
 1 file changed, 74 insertions(+), 61 deletions(-)

diff --git a/README.md b/README.md
index 705cb33..e5e86d8 100644
--- a/README.md
+++ b/README.md
@@ -5,89 +5,102 @@ Provides helpful definitions for dealing with Apt.
 
 ## Usage
 
-### apt:builddep
+### apt
+The apt class provides a number of common resources and options which
+are shared by the various defined types in this module. This class
+should always be included in your manifests if you are using the `apt`
+module.
+
+    class { 'apt':
+      $always_apt_update    = false,
+      $disable_keys         = undef,
+      $proxy_host           = false,
+      $proxy_port           = '8080',
+      $purge_sources_list   = false,
+      $purge_sources_list_d = false,
+      $purge_preferences_d  = false
+    }
+
+### apt::builddep
 Install the build depends of a specified package.
-<pre>
-apt::builddep { "glusterfs-server": }
-</pre>
+
+    apt::builddep { "glusterfs-server": }
 
 ### apt::force
-Force a package to be installed from a specific release.  Useful when using repositories like Debian unstable in Ubuntu.
-<pre>
-apt::force { "glusterfs-server":
-	release => "unstable",
-	version => '3.0.3',
-	require => Apt::Source["debian_unstable"],
-}
-</pre>
+Force a package to be installed from a specific release.  Useful when
+using repositories like Debian unstable in Ubuntu.
+
+    apt::force { "glusterfs-server":
+	  release => "unstable",
+	  version => '3.0.3',
+	  require => Apt::Source["debian_unstable"],
+    }
 
 ### apt::pin
 Add an apt pin for a certain release.
-<pre>
-apt::pin { "karmic": priority => 700 }
-apt::pin { "karmic-updates": priority => 700 }
-apt::pin { "karmic-security": priority => 700 }
-</pre>
+
+    apt::pin { "karmic": priority => 700 }
+    apt::pin { "karmic-updates": priority => 700 }
+    apt::pin { "karmic-security": priority => 700 }
 
 ### apt::ppa
 Add a ppa repository using `add-apt-repository`.  Somewhat experimental.
-<pre>
-apt::ppa { "ppa:drizzle-developers/ppa": }
-</pre>
+
+    apt::ppa { "ppa:drizzle-developers/ppa": }
 
 ### apt::release
-Set the default apt release.  Useful when using repositories like Debian unstable in Ubuntu.
-<pre>
-apt::release { "karmic": }
-</pre>
+Set the default apt release.  Useful when using repositories like
+Debian unstable in Ubuntu.
+
+    apt::release { "karmic": }
 
 ### apt::source
 Add an apt source to `/etc/apt/sources.list.d/`.
-<pre>
-apt::source { "debian_unstable":
-  location          => "http://debian.mirror.iweb.ca/debian/",
-  release           => "unstable",
-  repos             => "main contrib non-free",
-  required_packages => "debian-keyring debian-archive-keyring",
-  key               => "55BE302B",
-  key_server        => "subkeys.pgp.net",
-  pin               => "-10",
-  include_src       => true
-}
-</pre>
-
-This source will configure your system for the Puppet Labs APT repository.
-<pre>
-apt::source { 'puppetlabs':
-  location   => 'http://apt.puppetlabs.com',
-  repos      => 'main',
-  key        => '4BD6EC30',
-  key_server => 'pgp.mit.edu',
-}
-</pre>
+
+    apt::source { "debian_unstable":
+      location          => "http://debian.mirror.iweb.ca/debian/",
+      release           => "unstable",
+      repos             => "main contrib non-free",
+      required_packages => "debian-keyring debian-archive-keyring",
+      key               => "55BE302B",
+      key_server        => "subkeys.pgp.net",
+      pin               => "-10",
+      include_src       => true
+    }
+
+This source will configure your system for the Puppet Labs APT
+repository.
+
+    apt::source { 'puppetlabs':
+      location   => 'http://apt.puppetlabs.com',
+      repos      => 'main',
+      key        => '4BD6EC30',
+      key_server => 'pgp.mit.edu',
+    }
 
 ### apt::key
 Add a key to the list of keys used by apt to authenticate packages.
-<pre>
-apt::key { "puppetlabs":
-  key        => "4BD6EC30",
-  key_server => "pgp.mit.edu",
-}
-</pre>
 
-<pre>
-apt::key { "jenkins":
-  key        => "D50582E6",
-  key_source => "http://pkg.jenkins-ci.org/debian/jenkins-ci.org.key",
-}
-</pre>
+    apt::key { "puppetlabs":
+      key        => "4BD6EC30",
+      key_server => "pgp.mit.edu",
+    }
+
+    apt::key { "jenkins":
+      key        => "D50582E6",
+      key_source => "http://pkg.jenkins-ci.org/debian/jenkins-ci.org.key",
+    }
 
-Note that use of the "key_source" parameter requires wget to be installed and working.
+Note that use of the "key_source" parameter requires wget to be
+installed and working.
 
 
 ## Contributors
-A lot of great people have contributed to this module. A somewhat current list follows.  
-Ben Godfrey <ben.godfrey@wonga.com>  
+A lot of great people have contributed to this module. A somewhat
+current list follows.
+
+Ben Godfrey <ben.godfrey@wonga.com>
+Branan Purvine-Riley <branan@puppetlabs.com>
 Christian G. Warden <cwarden@xerus.org>  
 Dan Bode <bodepd@gmail.com> <dan@puppetlabs.com>  
 Garrett Honeycutt <github@garretthoneycutt.com>  
-- 
2.32.3