• Top
  • Documentation
  • Books
  • Boolean-reasoning
  • Projects
  • Debugging
  • Std
  • Proof-automation
  • Macro-libraries
  • ACL2
  • Interfacing-tools
  • Hardware-verification
    • Gl
    • Esim
    • Vl2014
      • Warnings
      • Primitives
      • Use-set
      • Syntax
        • Vl-module
        • Vl-vardecl
        • Expressions
        • Vl-fundecl
        • Vl-assign
        • Vl-gateinst
        • Vl-modinst
        • Vl-commentmap
          • Vl-commentmap-p
            • Vl-descriptionlist-inject-comments-aux
            • Vl-commentmap-entry-sort
            • Vl-commentmap-falp
            • Vl-adjust-minloc-for-comments
            • Vl-kill-whitespace-and-comments
            • Vl-description-inject-comments
            • Vl-gather-comments
            • Vl-descriptionlist-inject-comments
            • Vl-description-add-warning
            • Vl-description-set-comments
            • Vl-gather-comments-fal
            • Vl-commentmap-fal
            • Vl-description->minloc
            • Vl-description->maxloc
            • Vl-description->comments
            • Vl-description-has-comments-p
          • Vl-commentmap-fix
          • Vl-commentmap-equiv
        • Vl-portdecl
        • Vl-taskdecl
        • Vl-design
        • Vl-interface
        • Vl-plainarglist->exprs
        • Vl-taskdecllist->names
        • Vl-fundecllist->names
        • Vl-package
        • Vl-port
        • Vl-udp
        • Vl-paramdecl
        • Vl-genelement
        • Vl-cycledelayrange
        • Vl-namedarg
        • Vl-sort-blockitems-aux
        • Vl-distitem
        • Vl-gatedelay
        • Vl-repetition
        • Vl-typedef
        • Vl-range
        • Vl-gatestrength
        • Vl-program
        • Vl-config
        • Vl-always
        • Vl-datatype-update-dims
        • Vl-import
        • Vl-enumbasetype
        • Vl-repeateventcontrol
        • Vl-paramargs
        • Vl-initial
        • Vl-eventcontrol
        • Vl-udpsymbol-p
        • Vl-maybe-range
        • Vl-maybe-nettypename
        • Vl-maybe-gatestrength
        • Vl-maybe-gatedelay
        • Vl-maybe-delayoreventcontrol
        • Vl-alias
        • Maybe-string-fix
        • Vl-maybe-packeddimension
        • Vl-fwdtypedef
        • Vl-evatom
        • Vl-packeddimension-p
        • Vl-maybe-udpsymbol
        • Vl-maybe-module
        • Vl-maybe-direction
        • Vl-maybe-datatype
        • Vl-maybe-cstrength
        • Vl-direction-p
        • Vl-arguments
        • Vl-maybe-design
        • Vl-udpline
        • Vl-exprdist
        • Vl-context1
        • Vl-genvar
        • Vl-enumitem
        • Vl-datatype-update-udims
        • Vl-datatype-update-pdims
        • Vl-modelement
        • Vl-udpedge
        • Vl-delaycontrol
        • Vl-context
        • Vl-sort-blockitems
        • Vl-distweighttype-p
        • Vl-ctxelement->loc
        • Vl-blockitem
        • Vl-vardecllist
        • Vl-module->ifports
        • Vl-modelement->loc
        • Vl-ctxelement
        • Vl-coretypename-p
        • Vl-packeddimensionlist
        • Vl-modelementlist->genelements
        • Vl-gatetype-p
        • Vl-paramdecllist
        • Vl-lifetime-p
        • Vl-datatype->udims
        • Vl-datatype->pdims
        • Vl-timeunit-p
        • Vl-repetitiontype-p
        • Vl-port->name
        • Vl-importlist
        • Vl-genelement->loc
        • Vl-delayoreventcontrol
        • Vl-cstrength-p
        • Statements
        • Vl-udpentry-p
        • Vl-packeddimension-fix
        • Vl-nettypename-p
        • Vl-portdecllist
        • Vl-port->loc
        • Vl-enumbasekind-fix
        • Vl-arguments->args
        • Vl-taskdecllist
        • Vl-portlist
        • Vl-importpart-p
        • Vl-importpart-fix
        • Vl-fundecllist
        • Vl-blockstmt-p
        • Vl-assignlist
        • Vl-alwaystype-p
        • Vl-typedeflist
        • Vl-syntaxversion-p
        • Vl-randomqualifier-p
        • Vl-modinstlist
        • Vl-gateinstlist
        • Vl-blockitemlist
        • Vl-udptable
        • Vl-udplist
        • Vl-udpentrylist
        • Vl-programlist
        • Vl-paramvaluelist
        • Vl-packagelist
        • Vl-namedparamvaluelist
        • Vl-namedarglist
        • Vl-modulelist
        • Vl-modportlist
        • Vl-modport-portlist
        • Vl-interfacelist
        • Vl-initiallist
        • Vl-genvarlist
        • Vl-fwdtypedeflist
        • Vl-evatomlist
        • Vl-enumitemlist
        • Vl-distlist
        • Vl-configlist
        • Vl-alwayslist
        • Vl-aliaslist
        • Vl-regularportlist
        • Vl-rangelist-list
        • Vl-rangelist
        • Vl-paramdecllist-list
        • Vl-modelementlist
        • Vl-maybe-range-list
        • Vl-interfaceportlist
        • Vl-argumentlist
        • Data-types
      • Getting-started
      • Utilities
      • Loader
      • Transforms
      • Lint
      • Mlib
      • Server
      • Kit
      • Printer
      • Esim-vl
      • Well-formedness
    • Sv
    • Vwsim
    • Fgl
    • Vl
    • X86isa
    • Svl
    • Rtl
  • Software-verification
  • Math
  • Testing-utilities

• Vl-commentmap-p

Vl-description-set-comments

Signature

(vl-description-set-comments x comments) → new-x

Arguments

x — Guard (vl-description-p x).

comments — Guard (vl-commentmap-p comments).

Returns

new-x — Type (vl-description-p new-x).

Definitions and Theorems

Function: vl-description-set-comments

(defun vl-description-set-comments (x comments)
  (declare (xargs :guard (and (vl-description-p x)
                              (vl-commentmap-p comments))))
  (declare (xargs :guard (vl-description-has-comments-p x)))
  (let ((__function__ 'vl-description-set-comments))
    (declare (ignorable __function__))
    (b* ((x (vl-description-fix x)))
      (case (tag x)
            (:vl-module (change-vl-module x :comments comments))
            (:vl-udp (change-vl-udp x :comments comments))
            (:vl-interface (change-vl-interface x
                                                :comments comments))
            (:vl-package (change-vl-package x
                                            :comments comments))
            (:vl-program (change-vl-program x
                                            :comments comments))
            (:vl-config (change-vl-config x :comments comments))
            (:vl-typedef (change-vl-typedef x
                                            :comments comments))
            (otherwise (progn$ (impossible) x))))))

Theorem: vl-description-p-of-vl-description-set-comments

(defthm vl-description-p-of-vl-description-set-comments
  (b* ((new-x (vl-description-set-comments x comments)))
    (vl-description-p new-x))
  :rule-classes :rewrite)

Theorem: vl-description->name-of-vl-description-set-comments

(defthm vl-description->name-of-vl-description-set-comments
 (equal
     (vl-description->name (vl-description-set-comments x comments))
     (vl-description->name x)))