Internals: Cleanup some docstrfmt issues.

This commit is contained in:
Wilson Snyder 2025-12-20 22:41:26 -05:00
parent fa99e7b697
commit 32dafdcc61
11 changed files with 48 additions and 41 deletions

View File

@ -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 3. If using delays and :vlopt:`--timing`, there are two additional methods
the user should call: the user should call:
* ``designp->eventsPending()``, which returns ``true`` if there are * ``designp->eventsPending()``, which returns ``true`` if there are any
any delayed events pending, delayed events pending,
* ``designp->nextTimeSlot()``, which returns the simulation time of the * ``designp->nextTimeSlot()``, which returns the simulation time of the
next delayed event. This method can only be called if next delayed event. This method can only be called if
``designp->eventsPending()`` returned ``true``. ``designp->eventsPending()`` returned ``true``.
Call ``eventsPending()`` to check if you should continue with the Call ``eventsPending()`` to check if you should continue with the
simulation, and then ``nextTimeSlot()`` to move simulation time forward. simulation, and then ``nextTimeSlot()`` to move simulation time forward.
:vlopt:`--main` can be used with :vlopt:`--timing` to generate a basic example :vlopt:`--main` can be used with :vlopt:`--timing` to generate a basic
of a timing-enabled eval loop. example of a timing-enabled eval loop.
When ``eval()`` (or ``eval_step()``) is called Verilator looks for changes When ``eval()`` (or ``eval_step()``) is called Verilator looks for changes
in clock signals and evaluates related sequential always blocks, such as in clock signals and evaluates related sequential always blocks, such as

View File

@ -29,9 +29,10 @@ Alliance <https://chipsalliance.org>`_, and `Antmicro Ltd
Previous major corporate sponsors of Verilator, by providing significant Previous major corporate sponsors of Verilator, by providing significant
contributions of time or funds include: Antmicro Ltd., Atmel Corporation, contributions of time or funds include: Antmicro Ltd., Atmel Corporation,
Compaq Corporation, Digital Equipment Corporation, Embecosm Ltd., Fractile Compaq Corporation, Digital Equipment Corporation, Embecosm Ltd., Fractile
Ltd., Hicamp Systems, Intel Corporation, Marvell Inc., Mindspeed Technologies Ltd., Hicamp Systems, Intel Corporation, Marvell Inc., Mindspeed
Inc., MicroTune Inc., picoChip Designs Ltd., Sun Microsystems Inc., Nauticus Technologies Inc., MicroTune Inc., picoChip Designs Ltd., Sun Microsystems
Networks Inc., SiCortex Inc, Shunyao CAD, and Western Digital Inc. Inc., Nauticus Networks Inc., SiCortex Inc, Shunyao CAD, and Western
Digital Inc.
The contributors of major functionality are: Jeremy Bennett, Krzysztof The contributors of major functionality are: Jeremy Bennett, Krzysztof
Bieganski, Byron Bradley, Lane Brooks, John Coiner, Duane Galbi, Arkadiusz Bieganski, Byron Bradley, Lane Brooks, John Coiner, Duane Galbi, Arkadiusz

View File

@ -39,8 +39,7 @@ Breaking this command down:
#. :vlopt:`-j` `0` to Verilate using use as many CPU threads as the machine #. :vlopt:`-j` `0` to Verilate using use as many CPU threads as the machine
has. has.
#. :vlopt:`-Wall` so Verilator has stronger lint warnings #. :vlopt:`-Wall` so Verilator has stronger lint warnings enabled.
enabled.
#. An finally, :command:`our.v`, which is our SystemVerilog design file. #. An finally, :command:`our.v`, which is our SystemVerilog design file.

View File

@ -60,8 +60,7 @@ Breaking this command down:
#. :vlopt:`-j 0 <-j>` to Verilate using use as many CPU threads as the #. :vlopt:`-j 0 <-j>` to Verilate using use as many CPU threads as the
machine has. machine has.
#. :vlopt:`-Wall` so Verilator has stronger lint warnings #. :vlopt:`-Wall` so Verilator has stronger lint warnings enabled.
enabled.
#. And finally, :command:`our.v` which is our SystemVerilog design file. #. And finally, :command:`our.v` which is our SystemVerilog design file.

View File

@ -1,9 +1,9 @@
.. Copyright 2003-2025 by Wilson Snyder. .. Copyright 2003-2025 by Wilson Snyder.
.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
===================== ===================
Language Extensions Language Extensions
===================== ===================
The following additional constructs are the extensions Verilator supports The following additional constructs are the extensions Verilator supports
on top of standard Verilog code. Using these features outside of comments on top of standard Verilog code. Using these features outside of comments

View File

@ -403,8 +403,8 @@ How do I get faster build times?
environment variable to override this. Also see the environment variable to override this. Also see the
:vlopt:`--output-split` option and :ref: `Profiling ccache efficiency`. :vlopt:`--output-split` option and :ref: `Profiling ccache efficiency`.
* To reduce the compile time of classes that use a Verilated module (e.g., a * To reduce the compile time of classes that use a Verilated module (e.g.,
top CPP file) you may wish to add a a top CPP file) you may wish to add a
:option:`/*verilator&32;no_inline_module*/` metacomment to your top-level :option:`/*verilator&32;no_inline_module*/` metacomment to your top-level
module. This will decrease the amount of code in the model's Verilated module. This will decrease the amount of code in the model's Verilated
class, improving compile times of any instantiating top-level C++ code, class, improving compile times of any instantiating top-level C++ code,

View File

@ -163,10 +163,10 @@ packages (see internals.rst), and a Python virtual environment:
cpan install Pod::Perldoc cpan install Pod::Perldoc
The Python virtual environment is only required for running the whole test The Python virtual environment is only required for running the whole test
suite, and for additional development steps like linting and formatting. It is suite, and for additional development steps like linting and formatting. It
not required for building Verilator itself. To install the python virtual is not required for building Verilator itself. To install the python
environment and all dependencies automatically, run the following once, after virtual environment and all dependencies automatically, run the following
``configure``: once, after ``configure``:
.. code-block:: bash .. code-block:: bash

View File

@ -143,8 +143,8 @@ error, except:
* delay statements - they are ignored (as they are in synthesis), though they * delay statements - they are ignored (as they are in synthesis), though they
do issue a :option:`STMTDLY` warning, do issue a :option:`STMTDLY` warning,
* intra-assignment timing controls - they are ignored, though they do issue an * intra-assignment timing controls - they are ignored, though they do issue
:option:`ASSIGNDLY` warning, an :option:`ASSIGNDLY` warning,
* net delays - they are ignored, * net delays - they are ignored,
* event controls at the top of the procedure, * event controls at the top of the procedure,

View File

@ -22,8 +22,8 @@ Verilator may be used in five major ways:
that may be used to feed into other user-designed tools. that may be used to feed into other user-designed tools.
* With the :vlopt:`-E` option, Verilator will preprocess the code according * With the :vlopt:`-E` option, Verilator will preprocess the code according
to IEEE preprocessing rules and write the output to standard out. This to IEEE preprocessing rules and write the output to standard out. This is
is useful to feed other tools and to debug how "\`define" statements are useful to feed other tools and to debug how "\`define" statements are
expanded. 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 :vlopt:`-f` files, and parses all modules within. Each module is assigned
to the most recent library specified with :vlopt:`-work`, thus `-work liba 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 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 `b.v` to `libb`. In the absence of a `-work` mapping, each module is
assigned to a library based on mappings provided by :vlopt:`-libmap`. 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 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 attempts to find a filename constructed from the module name using

View File

@ -1,9 +1,9 @@
.. Copyright 2003-2025 by Wilson Snyder. .. Copyright 2003-2025 by Wilson Snyder.
.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
===================== ===================
Errors and Warnings Errors and Warnings
===================== ===================
.. _disabling warnings: .. _disabling warnings:
@ -46,8 +46,8 @@ Warnings may be disabled in multiple ways:
lint_off -rule UNSIGNED -file "*/example.v" -lines 1 lint_off -rule UNSIGNED -file "*/example.v" -lines 1
Metacomments and control file directives do not interact. If a warning is 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 disabled by either metacomments, or a directive in a control file, it will
be emitted. not be emitted.
Error And Warning Format Error And Warning Format
======================== ========================

View File

@ -1,8 +1,8 @@
|Logo| |Logo|
===================== ===================
Verilator Internals Verilator Internals
===================== ===================
.. contents:: .. contents::
:depth: 3 :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 into Verilator, replacing on the command line all of the previous input
files, to enable simplification of test cases. This file also contains most files, to enable simplification of test cases. This file also contains most
command line arguments Verilator was invoked as `// verilator fargs`` command line arguments Verilator was invoked as `// verilator fargs``
metacomments, with and can be parsed by ``-f`. So to reproduce the run that metacomments, with and can be parsed by `\`-f`. So to reproduce the run
created the file, run: that created the file, run:
:: ::
verilator -f <prefix>__inputs.vpp <prefix>__inputs.vpp 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 ``src/.gdbinit`` and ``src/.gdbinit.py`` define handy utilities for working
with JSON AST dumps. For example: with JSON AST dumps. For example:
* ``jstash nodep`` - Perform a JSON AST dump and save it into GDB value history (e.g. ``$1``) * ``jstash nodep`` - Perform a JSON AST dump and save it into GDB value
* ``jtree nodep`` - Perform a JSON AST dump and pretty print it using ``astsee_verilator``. history (e.g. ``$1``)
* ``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 nodep`` - Perform a JSON AST dump and pretty print it using
* ``jtree 0x55555613dca0`` - Pretty print using address literal (rather than actual pointer). ``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. * ``jtree $1 nodep`` - Diff ``nodep`` against an older dump.
A detailed description of ``jstash`` and ``jtree`` can be displayed using A detailed description of ``jstash`` and ``jtree`` can be displayed using