• 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-gather-opts-p
              • Parse-vl-gather-opts
              • Vl-gather-opts
              • Make-vl-gather-opts
              • Change-vl-gather-opts
              • Honsed-vl-gather-opts
              • Make-honsed-vl-gather-opts
              • *vl-gather-opts-usage*
              • Vl-gather-opts->strict
              • Vl-gather-opts->start-files
              • Vl-gather-opts->search-path
              • Vl-gather-opts->search-exts
              • Vl-gather-opts->readme
              • Vl-gather-opts->plusargs
              • Vl-gather-opts->output
              • Vl-gather-opts->mem
              • Vl-gather-opts->include-dirs
              • Vl-gather-opts->help
              • Vl-gather-opts->edition
              • Vl-gather-opts->defines
            • Vl-modulelist-original-sources
            • Vl-module-original-source
            • Vl-gather-top
            • *vl-gather-help*
            • Vl-gather-main
            • Vl-design-original-source
          • Vl-zip
          • Vl-main
          • Split-plusargs
          • Vl-shell
          • Vl-json
        • Mlib
        • Transforms
      • X86isa
      • Svl
      • Rtl
    • Software-verification
    • Testing-utilities
    • Math
  • Vl-gather

Vl-gather-opts-p

Options for running vl gather.

(vl-gather-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).
  • output — Default is "vl_gather.v". Where to write the collected up modules.
        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 — Plusargs with plusses removed.
        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.v" in the --search directories. But if you have Verilog files with different extensions, this won't work, so you can add these extensions here. EXT should not include the period, e.g., use "--searchext vv" to consider files like "foo.vv", etc.
        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-gather-opts-p

Subtopics

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