• 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
        • Getting-started
        • Utilities
        • Loader
        • Transforms
        • Lint
        • Mlib
        • Server
          • Vls-commands
          • Vl-descriptionlist-summaries
          • Vls-transdb
          • File-layout
          • Vls-data-p
          • Ts-queue
          • Vls-showloc
          • Vls-get-plainsrc
          • Vl-description->warnings
          • Vl-describe
            • Vls-port-table
            • Vls-describe
            • Vls-data-from-translation
            • Vl-find-description-insensitive
            • Vls-get-warnings
            • Vls-get-summary
            • Vls-get-origsrc
            • Vls-data-origname-reportcard
            • Vls-get-parents
            • Vls-get-children
            • Vls-get-summaries
            • Vl-ppc-description
            • Vls-get-desctypes
            • Vl-description-summary
            • Start
            • Vl-descalist->descriptions/types
            • Stop
          • Kit
          • Printer
          • Esim-vl
          • Well-formedness
        • Sv
        • Fgl
        • Vwsim
        • Vl
        • X86isa
        • Svl
        • Rtl
      • Software-verification
      • Math
      • Testing-utilities
    • Server

    Vl-describe

    (vl-describe name x) describes the uses of name in the module x.

    Signature
    (vl-describe name x) → *
    Arguments
    name — Guard (stringp name).
    x — Guard (vl-module-p x).

    This is a useful way to interactively inspect modules. The name is typically some kind of name that is used within the module x, and might be the name of a wire, port, parameter, submodule instance, or what have you.

    vl-describe looks through the module for uses of this name and returns a human-readable string that describes what it has found. This report is meant to describe all of the places that name is used.