• Top
    • Documentation
    • Books
    • Recursion-and-induction
    • 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-zip-opts-p
              • Parse-vl-zip-opts
              • Vl-zip-opts
              • Make-vl-zip-opts
              • Change-vl-zip-opts
              • Honsed-vl-zip-opts
              • Make-honsed-vl-zip-opts
              • *vl-zip-opts-usage*
              • Vl-zip-opts->strict
              • Vl-zip-opts->start-files
              • Vl-zip-opts->search-path
              • Vl-zip-opts->search-exts
              • Vl-zip-opts->readme
              • Vl-zip-opts->plusargs
              • Vl-zip-opts->output
              • Vl-zip-opts->name
              • Vl-zip-opts->mem
              • Vl-zip-opts->include-dirs
              • Vl-zip-opts->help
              • Vl-zip-opts->edition
              • Vl-zip-opts->defines
            • Vl-zipfile
            • *vl-zip-help*
            • Vl-zip-top
            • Vl-zip-main
          • Vl-main
          • Split-plusargs
          • Vl-shell
          • Vl-json
        • Mlib
        • Transforms
      • X86isa
      • Svl
      • Rtl
    • Software-verification
    • Testing-utilities
    • Math
  • Vl-zip

Vl-zip-opts-p

Options for running vl zip.

(vl-zip-opts-p x) is a defaggregate of the following fields.

  • help — Show a brief usage message and exit.
        Invariant (booleanp help).
  • readme — Show a more elaborate README and exit.
        Invariant (booleanp readme).
  • name — Default is "design". Should be a short name that identifies the project that this zip file is parsing. This controls how the file will be presented in the "Choose Model" screen in the Module Browser.
        Invariant (stringp name).
  • output — Default is "design.vlzip". Where to write the collected up modules. Typically this should have a .vlzip extension.
        Invariant (stringp output).
  • start-files — The list of files to parse. (Not options; this is the rest of the command line, hence :hide t).
        Invariant (string-listp start-files).
  • plusargs — The list of plusargs without plusses.
        Invariant (string-listp plusargs).
  • search-path — Control the search path for finding modules. You can give this switch multiple times, to set up multiple search paths in priority order.
        Invariant (string-listp search-path).
  • include-dirs — Control the list of directories for `include files. You can give this switch multiple times. By default, we look only in the current directory.
        Invariant (string-listp include-dirs).
  • search-exts — Control the search extensions for finding modules. You can give this switch multiple times. By default we just look for files named "foo.sv" and "foo.v" in the --search directories. If you have Verilog files with different extensions, this won't work, so you can add these extensions here.
        Invariant (string-listp search-exts).
  • defines — Set up definitions to use before parsing begins. For instance, "--define foo" is similar to "`define foo" and "--define foo=3" is similar to "`define foo 3". Note: these defines are "sticky" and will override subsequent `defines in your Verilog files unless your Verilog explicitly uses `undef. You can give this option multiple times.
        Invariant (string-listp defines).
  • edition — Which edition of the Verilog standard to implement? Default: "SystemVerilog" (IEEE 1800-2012). You can alternately use "Verilog" for IEEE 1364-2005, i.e., Verilog-2005.
        Invariant (vl-edition-p edition).
  • strict — Disable VL extensions to Verilog.
        Invariant (booleanp strict).
  • mem — How much memory to try to use. Default: 4 GB. Raising this may improve performance by avoiding garbage collection. To avoid swapping, keep this below (physical_memory - 2 GB).
        Invariant (posp mem).

Source link: vl-zip-opts-p

Subtopics

Parse-vl-zip-opts
Parse arguments from the command line into a vl-zip-opts-p aggregate.
Vl-zip-opts
Raw constructor for vl-zip-opts-p structures.
Make-vl-zip-opts
Constructor macro for vl-zip-opts-p structures.
Change-vl-zip-opts
A copying macro that lets you create new vl-zip-opts-p structures, based on existing structures.
Honsed-vl-zip-opts
Raw constructor for honsed vl-zip-opts-p structures.
Make-honsed-vl-zip-opts
Constructor macro for honsed vl-zip-opts-p structures.
*vl-zip-opts-usage*
Automatically generated usage message.
Vl-zip-opts->strict
Access the strict field of a vl-zip-opts-p structure.
Vl-zip-opts->start-files
Access the start-files field of a vl-zip-opts-p structure.
Vl-zip-opts->search-path
Access the search-path field of a vl-zip-opts-p structure.
Vl-zip-opts->search-exts
Access the search-exts field of a vl-zip-opts-p structure.
Vl-zip-opts->readme
Access the readme field of a vl-zip-opts-p structure.
Vl-zip-opts->plusargs
Access the plusargs field of a vl-zip-opts-p structure.
Vl-zip-opts->output
Access the output field of a vl-zip-opts-p structure.
Vl-zip-opts->name
Access the name field of a vl-zip-opts-p structure.
Vl-zip-opts->mem
Access the mem field of a vl-zip-opts-p structure.
Vl-zip-opts->include-dirs
Access the include-dirs field of a vl-zip-opts-p structure.
Vl-zip-opts->help
Access the help field of a vl-zip-opts-p structure.
Vl-zip-opts->edition
Access the edition field of a vl-zip-opts-p structure.
Vl-zip-opts->defines
Access the defines field of a vl-zip-opts-p structure.