• Top
    • Documentation
    • Books
    • Boolean-reasoning
    • Projects
    • Debugging
    • Std
    • Community
    • 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
        • Kit
          • Vl-model
          • Vl-json
          • Vl-gather
          • Vl-server
          • Vl-pp
          • Vl-lint
          • Vl-main
          • Vl-toolkit-other-command
          • Vl-help
            • Vl-toolkit-help-message
              • Vl-toolkit-help-message-default
        • Printer
        • Esim-vl
        • Well-formedness
      • Sv
      • Fgl
      • Vwsim
      • Vl
      • X86isa
      • Svl
      • Rtl
    • Software-verification
    • Math
    • Testing-utilities
  • Vl-help

Vl-toolkit-help-message

Look up the help message for a VL kit program.

This is attachable so advanced users can add additional commands.

Definition: *vl-help-messages*

(defconst *vl-help-messages*
  (list (cons "help" *vl-generic-help*)
        (cons "json" *vl-json-help*)
        (cons "lint" *vl-lint-help*)
        (cons "model" *vl-model-help*)
        (cons "stv2c" acl2::*stv2c-help*)
        (cons "pp" *vl-pp-help*)
        (cons "gather" *vl-gather-help*)
        (cons "server" *vl-server-help*)
        (cons "shell" *vl-shell-help*)))

Definition: vl-toolkit-help-message

(encapsulate (((vl-toolkit-help-message *)
               => *
               :formals (command)
               :guard (stringp command)))
  (local (value-triple :elided))
  (defthm vl-toolkit-help-message-constraint
    (or (not (vl-toolkit-help-message command))
        (stringp (vl-toolkit-help-message command)))
    :rule-classes :type-prescription))

Definitions and Theorems

Theorem: vl-toolkit-help-message-constraint

(defthm vl-toolkit-help-message-constraint
  (or (not (vl-toolkit-help-message command))
      (stringp (vl-toolkit-help-message command)))
  :rule-classes :type-prescription)

Subtopics

Vl-toolkit-help-message-default