1 files changed, 12 insertions, 0 deletions
diff --git a/lib/puppet/type/dns_zone.rb b/lib/puppet/type/dns_zone.rb
index a748770..3f49bc7 100644
--- a/lib/puppet/type/dns_zone.rb
+++ b/lib/puppet/type/dns_zone.rb
@@ -6,6 +6,18 @@ Puppet::Type.newtype(:dns_zone) do
 
   # ensurable
 
+  @doc = %q{
+  Manage the zonefile /var/named/dynamic/db.${zone}, and its records.
+
+  The zone can still be edited by hand, but invalid record might cause
+  puppet to do interesting things. Note that records directly on the
+  zone MUST have @ as key (instead of blank).
+
+  Existing $TTL directives in the zone are kept, but there is no way
+  to set it through this library (due to limitations in the zonefile
+  library).
+  }
+
   newproperty(:ensure) do
     desc "Ensurable"
     # newvalues(:present, :absent)