• Top
  • Documentation
  • Books
  • Boolean-reasoning
  • Projects
  • Debugging
  • Std
  • Proof-automation
  • Macro-libraries
  • ACL2
  • Interfacing-tools
  • Hardware-verification
    • Gl
    • Esim
    • Vl2014
    • Sv
    • Vwsim
    • Fgl
    • Vl
      • Syntax
      • Loader
      • Warnings
      • Getting-started
      • Utilities
      • Printer
      • Kit
        • Vl-lint
        • Vl-server
        • Vl-gather
        • Vl-zip
        • Vl-main
          • Vl-toolkit-other-command
          • Vl-help
            • Vl-toolkit-help-message
              • Vl-toolkit-help-message-default
        • Split-plusargs
        • Vl-shell
        • Vl-json
      • Mlib
      • Transforms
    • 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 "lint" *vl-lint-help*)
        (cons "gather" *vl-gather-help*)
        (cons "server" *vl-server-help*)
        (cons "shell" *vl-shell-help*)
        (cons "zip" *vl-zip-help*)
        (cons "json" *vl-json-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