1.0.4.5 slot reader/writer documentation in the manual
authorRudi Schlatte <rudi@constantly.at>
Tue, 27 Mar 2007 05:58:07 +0000 (05:58 +0000)
committerRudi Schlatte <rudi@constantly.at>
Tue, 27 Mar 2007 05:58:07 +0000 (05:58 +0000)
  * Also remove writers for sb-bsd-sockets:host-ent class slots
  * Thanks to Richard M Kreuter

NEWS
contrib/sb-bsd-sockets/name-service.lisp
doc/manual/docstrings.lisp
version.lisp-expr

diff --git a/NEWS b/NEWS
index ee9f95d..bbe8edc 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -1,6 +1,11 @@
 ;;;; -*- coding: utf-8; -*-
 changes in sbcl-1.0.5 relative to sbcl-1.0.4:
+  * incompatible change: removed writer methods for host-ent-name,
+    host-ent-addresses -- changing the values did not update the DNS
+    information anyway.
   * minor incompatible change: changed experimental JOIN-THREAD interface
+  * documentation: the manual now lists reader and writer methods
+    in class slot documentation sections. (thanks to Richard M Kreuter)
   * documentation: unwinding from asyncronous events has been
     documented as unsafe.
   * documentation: SB-SYS:WITHOUT-GCING has been documented as unsafe
index 40c9cf5..b5f9755 100644 (file)
@@ -1,16 +1,15 @@
 (in-package :sb-bsd-sockets)
 
 (defclass host-ent ()
-  ;; Unfortunately the docstring generator can't currently create.
-  ((name :initarg :name :accessor host-ent-name
+  ((name :initarg :name :reader host-ent-name
          :documentation "The name of the host")
    ;; Deliberately not documented, since this isn't very useful,
    ;; and the data isn't available when using getaddrinfo(). Unfortunately
    ;; it is exported.
-   (aliases :initarg :aliases :accessor host-ent-aliases)
+   (aliases :initarg :aliases :reader host-ent-aliases)
    ;; presently always AF_INET. Not exported.
-   (address-type :initarg :type :accessor host-ent-address-type)
-   (addresses :initarg :addresses :accessor host-ent-addresses
+   (address-type :initarg :type :reader host-ent-address-type)
+   (addresses :initarg :addresses :reader host-ent-addresses
               :documentation "A list of addresses for this host."))
   (:documentation "This class represents the results of an address lookup."))
 
@@ -109,7 +108,7 @@ weird stuff - see gethostbyname(3) or getaddrinfo(3) for the details."
                          ;; The same effective result can be multiple time
                          ;; in the list, with different socktypes. Only record
                          ;; each address once.
-                         (setf (host-ent-addresses host-ent)
+                         (setf (slot-value host-ent 'addresses)
                                (adjoin (naturalize-unsigned-byte-8-array address
                                                                          4)
                                        (host-ent-addresses host-ent)
index e5db38a..fbefde6 100644 (file)
@@ -711,10 +711,21 @@ followed another tabulation label or a tabulation body."
         (when slots
           (format *texinfo-output* "Slots:~%@itemize~%")
           (dolist (slot slots)
-            (format *texinfo-output* "@item ~(@code{~A} ~
-                                     ~@[--- initargs: @code{~{@w{~S}~^, ~}}~]~)~%~%"
+            (format *texinfo-output*
+                    "@item ~(@code{~A}~#[~:; --- ~]~
+                      ~:{~2*~@[~2:*~A~P: ~{@code{@w{~S}}~^, ~}~]~:^; ~}~)~%~%"
                     (slot-definition-name slot)
-                    (slot-definition-initargs slot))
+                    (remove
+                     nil
+                     (mapcar
+                      (lambda (name things)
+                        (if things
+                            (list name (length things) things)))
+                      '("initarg" "reader"  "writer")
+                      (list
+                       (slot-definition-initargs slot)
+                       (slot-definition-readers slot)
+                       (slot-definition-writers slot)))))
             ;; FIXME: Would be neater to handler as children
             (write-texinfo-string (docstring slot t)))
           (format *texinfo-output* "@end itemize~%~%"))))))
index adeed9c..82a441c 100644 (file)
@@ -17,4 +17,4 @@
 ;;; checkins which aren't released. (And occasionally for internal
 ;;; versions, especially for internal versions off the main CVS
 ;;; branch, it gets hairier, e.g. "0.pre7.14.flaky4.13".)
-"1.0.4.4"
+"1.0.4.5"