Internals: Cleanup some docstrfmt issues.
This commit is contained in:
parent
fa99e7b697
commit
32dafdcc61
|
|
@ -502,16 +502,16 @@ described above is just a wrapper which calls these two functions.
|
|||
3. If using delays and :vlopt:`--timing`, there are two additional methods
|
||||
the user should call:
|
||||
|
||||
* ``designp->eventsPending()``, which returns ``true`` if there are
|
||||
any delayed events pending,
|
||||
* ``designp->eventsPending()``, which returns ``true`` if there are any
|
||||
delayed events pending,
|
||||
* ``designp->nextTimeSlot()``, which returns the simulation time of the
|
||||
next delayed event. This method can only be called if
|
||||
``designp->eventsPending()`` returned ``true``.
|
||||
|
||||
Call ``eventsPending()`` to check if you should continue with the
|
||||
simulation, and then ``nextTimeSlot()`` to move simulation time forward.
|
||||
:vlopt:`--main` can be used with :vlopt:`--timing` to generate a basic example
|
||||
of a timing-enabled eval loop.
|
||||
:vlopt:`--main` can be used with :vlopt:`--timing` to generate a basic
|
||||
example of a timing-enabled eval loop.
|
||||
|
||||
When ``eval()`` (or ``eval_step()``) is called Verilator looks for changes
|
||||
in clock signals and evaluates related sequential always blocks, such as
|
||||
|
|
|
|||
|
|
@ -29,9 +29,10 @@ Alliance <https://chipsalliance.org>`_, and `Antmicro Ltd
|
|||
Previous major corporate sponsors of Verilator, by providing significant
|
||||
contributions of time or funds include: Antmicro Ltd., Atmel Corporation,
|
||||
Compaq Corporation, Digital Equipment Corporation, Embecosm Ltd., Fractile
|
||||
Ltd., Hicamp Systems, Intel Corporation, Marvell Inc., Mindspeed Technologies
|
||||
Inc., MicroTune Inc., picoChip Designs Ltd., Sun Microsystems Inc., Nauticus
|
||||
Networks Inc., SiCortex Inc, Shunyao CAD, and Western Digital Inc.
|
||||
Ltd., Hicamp Systems, Intel Corporation, Marvell Inc., Mindspeed
|
||||
Technologies Inc., MicroTune Inc., picoChip Designs Ltd., Sun Microsystems
|
||||
Inc., Nauticus Networks Inc., SiCortex Inc, Shunyao CAD, and Western
|
||||
Digital Inc.
|
||||
|
||||
The contributors of major functionality are: Jeremy Bennett, Krzysztof
|
||||
Bieganski, Byron Bradley, Lane Brooks, John Coiner, Duane Galbi, Arkadiusz
|
||||
|
|
|
|||
|
|
@ -39,8 +39,7 @@ Breaking this command down:
|
|||
#. :vlopt:`-j` `0` to Verilate using use as many CPU threads as the machine
|
||||
has.
|
||||
|
||||
#. :vlopt:`-Wall` so Verilator has stronger lint warnings
|
||||
enabled.
|
||||
#. :vlopt:`-Wall` so Verilator has stronger lint warnings enabled.
|
||||
|
||||
#. An finally, :command:`our.v`, which is our SystemVerilog design file.
|
||||
|
||||
|
|
|
|||
|
|
@ -60,8 +60,7 @@ Breaking this command down:
|
|||
#. :vlopt:`-j 0 <-j>` to Verilate using use as many CPU threads as the
|
||||
machine has.
|
||||
|
||||
#. :vlopt:`-Wall` so Verilator has stronger lint warnings
|
||||
enabled.
|
||||
#. :vlopt:`-Wall` so Verilator has stronger lint warnings enabled.
|
||||
|
||||
#. And finally, :command:`our.v` which is our SystemVerilog design file.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,9 +1,9 @@
|
|||
.. Copyright 2003-2025 by Wilson Snyder.
|
||||
.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
|
||||
|
||||
=====================
|
||||
Language Extensions
|
||||
=====================
|
||||
===================
|
||||
Language Extensions
|
||||
===================
|
||||
|
||||
The following additional constructs are the extensions Verilator supports
|
||||
on top of standard Verilog code. Using these features outside of comments
|
||||
|
|
|
|||
|
|
@ -403,8 +403,8 @@ How do I get faster build times?
|
|||
environment variable to override this. Also see the
|
||||
:vlopt:`--output-split` option and :ref: `Profiling ccache efficiency`.
|
||||
|
||||
* To reduce the compile time of classes that use a Verilated module (e.g., a
|
||||
top CPP file) you may wish to add a
|
||||
* To reduce the compile time of classes that use a Verilated module (e.g.,
|
||||
a top CPP file) you may wish to add a
|
||||
:option:`/*verilator&32;no_inline_module*/` metacomment to your top-level
|
||||
module. This will decrease the amount of code in the model's Verilated
|
||||
class, improving compile times of any instantiating top-level C++ code,
|
||||
|
|
|
|||
|
|
@ -163,10 +163,10 @@ packages (see internals.rst), and a Python virtual environment:
|
|||
cpan install Pod::Perldoc
|
||||
|
||||
The Python virtual environment is only required for running the whole test
|
||||
suite, and for additional development steps like linting and formatting. It is
|
||||
not required for building Verilator itself. To install the python virtual
|
||||
environment and all dependencies automatically, run the following once, after
|
||||
``configure``:
|
||||
suite, and for additional development steps like linting and formatting. It
|
||||
is not required for building Verilator itself. To install the python
|
||||
virtual environment and all dependencies automatically, run the following
|
||||
once, after ``configure``:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
|
|
|
|||
|
|
@ -143,8 +143,8 @@ error, except:
|
|||
|
||||
* delay statements - they are ignored (as they are in synthesis), though they
|
||||
do issue a :option:`STMTDLY` warning,
|
||||
* intra-assignment timing controls - they are ignored, though they do issue an
|
||||
:option:`ASSIGNDLY` warning,
|
||||
* intra-assignment timing controls - they are ignored, though they do issue
|
||||
an :option:`ASSIGNDLY` warning,
|
||||
* net delays - they are ignored,
|
||||
* event controls at the top of the procedure,
|
||||
|
||||
|
|
|
|||
|
|
@ -22,8 +22,8 @@ Verilator may be used in five major ways:
|
|||
that may be used to feed into other user-designed tools.
|
||||
|
||||
* With the :vlopt:`-E` option, Verilator will preprocess the code according
|
||||
to IEEE preprocessing rules and write the output to standard out. This
|
||||
is useful to feed other tools and to debug how "\`define" statements are
|
||||
to IEEE preprocessing rules and write the output to standard out. This is
|
||||
useful to feed other tools and to debug how "\`define" statements are
|
||||
expanded.
|
||||
|
||||
|
||||
|
|
@ -80,8 +80,9 @@ Verilator first reads all files provided on the command line and
|
|||
:vlopt:`-f` files, and parses all modules within. Each module is assigned
|
||||
to the most recent library specified with :vlopt:`-work`, thus `-work liba
|
||||
a.v -work libb b.v` will assign modules in `a.v` to `liba` and modules in
|
||||
`b.v` to `libb`. In the absence of a `-work` mapping, each module is optionally
|
||||
assigned to a library based on mappings provided by :vlopt:`-libmap`.
|
||||
`b.v` to `libb`. In the absence of a `-work` mapping, each module is
|
||||
optionally assigned to a library based on mappings provided by
|
||||
:vlopt:`-libmap`.
|
||||
|
||||
If a module is not defined from a file on the command-line, Verilator
|
||||
attempts to find a filename constructed from the module name using
|
||||
|
|
|
|||
|
|
@ -1,9 +1,9 @@
|
|||
.. Copyright 2003-2025 by Wilson Snyder.
|
||||
.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
|
||||
|
||||
=====================
|
||||
Errors and Warnings
|
||||
=====================
|
||||
===================
|
||||
Errors and Warnings
|
||||
===================
|
||||
|
||||
.. _disabling warnings:
|
||||
|
||||
|
|
@ -46,8 +46,8 @@ Warnings may be disabled in multiple ways:
|
|||
lint_off -rule UNSIGNED -file "*/example.v" -lines 1
|
||||
|
||||
Metacomments and control file directives do not interact. If a warning is
|
||||
disabled by either metacomments, or a directive in a control file, it will not
|
||||
be emitted.
|
||||
disabled by either metacomments, or a directive in a control file, it will
|
||||
not be emitted.
|
||||
|
||||
Error And Warning Format
|
||||
========================
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
|Logo|
|
||||
|
||||
=====================
|
||||
Verilator Internals
|
||||
=====================
|
||||
===================
|
||||
Verilator Internals
|
||||
===================
|
||||
|
||||
.. contents::
|
||||
:depth: 3
|
||||
|
|
@ -1771,8 +1771,8 @@ files that were read, filtered by preprocessing. This file can be fed back
|
|||
into Verilator, replacing on the command line all of the previous input
|
||||
files, to enable simplification of test cases. This file also contains most
|
||||
command line arguments Verilator was invoked as `// verilator fargs``
|
||||
metacomments, with and can be parsed by ``-f`. So to reproduce the run that
|
||||
created the file, run:
|
||||
metacomments, with and can be parsed by `\`-f`. So to reproduce the run
|
||||
that created the file, run:
|
||||
|
||||
::
|
||||
verilator -f <prefix>__inputs.vpp <prefix>__inputs.vpp
|
||||
|
|
@ -2095,11 +2095,18 @@ To print a node:
|
|||
``src/.gdbinit`` and ``src/.gdbinit.py`` define handy utilities for working
|
||||
with JSON AST dumps. For example:
|
||||
|
||||
* ``jstash nodep`` - Perform a JSON AST dump and save it into GDB value history (e.g. ``$1``)
|
||||
* ``jtree nodep`` - Perform a JSON AST dump and pretty print it using ``astsee_verilator``.
|
||||
* ``jtree $1`` - Pretty print a dump that was previously saved by ``jstash``.
|
||||
* ``jtree nodep -d '.file, .timeunit'`` - Perform a JSON AST dump, filter out some fields and pretty print it.
|
||||
* ``jtree 0x55555613dca0`` - Pretty print using address literal (rather than actual pointer).
|
||||
* ``jstash nodep`` - Perform a JSON AST dump and save it into GDB value
|
||||
history (e.g. ``$1``)
|
||||
|
||||
* ``jtree nodep`` - Perform a JSON AST dump and pretty print it using
|
||||
``astsee_verilator``.
|
||||
* ``jtree $1`` - Pretty print a dump that was previously saved by
|
||||
``jstash``.
|
||||
* ``jtree nodep -d '.file, .timeunit'`` - Perform a JSON AST dump, filter
|
||||
out some fields and pretty print it.
|
||||
|
||||
* ``jtree 0x55555613dca0`` - Pretty print using address literal (rather
|
||||
than actual pointer).
|
||||
* ``jtree $1 nodep`` - Diff ``nodep`` against an older dump.
|
||||
|
||||
A detailed description of ``jstash`` and ``jtree`` can be displayed using
|
||||
|
|
|
|||
Loading…
Reference in New Issue