zone.lisp (split-txt-data): Add documentation.

[zone] / zone.lisp

diff --git a/zone.lisp b/zone.lisp
index f68af5dcc4af293109494bfc82e1d43b62f7d9e8..f50c6d70e82766545478bda9c3b6b76ee635e876 100644 (file)
--- a/zone.lisp
+++ b/zone.lisp
@@ -869,6 +869,11 @@ (defmethod zone-record-rrdata ((type (eql :cname)) zr)
   5)
 
 (defun split-txt-data (data)
+  "Split the string DATA into pieces small enough to fit in a TXT record.
+
+   Return a list of strings L such that (a) (apply #'concatenate 'string L)
+   is equal to the original string DATA, and (b) (every (lambda (s) (<=
+   (length s) 255)) L) is true."
   (collecting ()
     (let ((i 0) (n (length data)))
       (loop