zone.lisp: Better documentation for reverse-zone directives.
authorMark Wooding <mdw@distorted.org.uk>
Sun, 11 Mar 2012 04:49:29 +0000 (04:49 +0000)
committerMark Wooding <mdw@distorted.org.uk>
Sun, 11 Mar 2012 04:49:29 +0000 (04:49 +0000)
zone.lisp

index d6c4174..7318c2a 100644 (file)
--- a/zone.lisp
+++ b/zone.lisp
           :data (ipnet-broadcast n)))))
 
 (defzoneparse (:rev :reverse) (name data rec)
-  ":reverse ((NET :bytes BYTES) ZONE*)"
+  ":reverse ((NET :bytes BYTES) ZONE*)
+
+   Add a reverse record each host in the ZONEs (or all zones) that lies
+   within NET.  The BYTES give the number of prefix labels generated; this
+   defaults to the smallest number of bytes needed to enumerate the net."
   (setf data (listify data))
   (destructuring-bind (net &key bytes) (listify (car data))
     (setf net (zone-parse-net net name))
                (setf (gethash name seen) t)))))))))
 
 (defzoneparse (:cidr-delegation :cidr) (name data rec :zname zname)
-  ":cidr-delegation ((NET :bytes BYTES) (TARGET-NET [TARGET-ZONE])*)"
+  ":cidr-delegation ((NET :bytes BYTES) ((TARGET-NET*) [TARGET-ZONE])*)
+
+   Insert CNAME records for delegating a portion of the reverse-lookup
+   namespace which doesn't align with an octet boundary.
+
+   The NET specifies the origin network, in which the reverse records
+   naturally lie.  The BYTES are the number of labels to supply for each
+   address; the default is the smallest number which suffices to enumerate
+   the entire NET.  The TARGET-NETs are subnets of NET which are to be
+   delegated.  The TARGET-ZONEs are the zones to which we are delegating
+   authority for the reverse records: the default is to append labels for those
+   octets of the subnet base address which are not the same in all address in
+   the subnet."
   (setf data (listify data))
   (destructuring-bind (net &key bytes) (listify (car data))
     (setf net (zone-parse-net net name))