		Search-engine friendly clone of the ACL2 documentation.

Server

Vls-describe

Signature
(vls-describe origname what data) → ans
Arguments: origname — Guard (stringp origname).; what — Guard (stringp what).; data — Guard (vls-data-p data).
Returns: ans — Type (stringp ans).

Definitions and Theorems

Function: vls-describe

(defun vls-describe (origname what data)
 (declare (xargs :guard (and (stringp origname)
                             (stringp what)
                             (vls-data-p data))))
 (let ((__function__ 'vls-describe))
   (declare (ignorable __function__))
   (b* (((vls-data data))
        (desc (cdr (hons-assoc-equal origname data.orig-descalist)))
        ((unless desc)
         (cat "Error: " origname " not found."))
        ((unless (mbe :logic (vl-module-p desc)
                      :exec (eq (tag desc) :vl-module)))
         (cat "BOZO implement describe page for "
              (ec-call (symbol-name (tag desc))))))
     (with-local-ps (vl-ps-update-htmlp t)
                    (vl-pp-describe what desc)))))

Theorem: stringp-of-vls-describe

(defthm stringp-of-vls-describe
  (b* ((ans (vls-describe origname what data)))
    (stringp ans))
  :rule-classes :type-prescription)