From 749b93e4053434590f3ee4358c06f2eb8624872f Mon Sep 17 00:00:00 2001 From: Wilson Snyder Date: Thu, 18 Jun 2026 21:58:01 -0400 Subject: [PATCH] Commentary: Use standard multiline rst comments, other cleanups --- README.rst | 9 +++--- ci/docker/buildenv/README.rst | 5 ++-- ci/docker/run/README.rst | 5 ++-- docs/CONTRIBUTING.rst | 5 ++-- docs/README.rst | 5 ++-- docs/guide/changes.rst | 5 ++-- docs/guide/connecting.rst | 5 ++-- docs/guide/contributing.rst | 5 ++-- docs/guide/contributors.rst | 5 ++-- docs/guide/control.rst | 5 ++-- docs/guide/copyright.rst | 5 ++-- docs/guide/deprecations.rst | 5 ++-- docs/guide/environment.rst | 5 ++-- docs/guide/example_binary.rst | 5 ++-- docs/guide/example_cc.rst | 5 ++-- docs/guide/example_common_install.rst | 5 ++-- docs/guide/example_dist.rst | 5 ++-- docs/guide/example_sc.rst | 5 ++-- docs/guide/examples.rst | 5 ++-- docs/guide/exe_sim.rst | 9 +++--- docs/guide/exe_verilator.rst | 7 +++-- docs/guide/exe_verilator_coverage.rst | 5 ++-- docs/guide/exe_verilator_gantt.rst | 5 ++-- docs/guide/exe_verilator_profcfunc.rst | 5 ++-- docs/guide/executables.rst | 5 ++-- docs/guide/extensions.rst | 5 ++-- docs/guide/faq.rst | 5 ++-- docs/guide/files.rst | 11 ++++--- docs/guide/index.rst | 5 ++-- docs/guide/install-cmake.rst | 5 ++-- docs/guide/install.rst | 5 ++-- docs/guide/languages.rst | 5 ++-- docs/guide/overview.rst | 5 ++-- docs/guide/simulating.rst | 40 +++++++++++++------------- docs/guide/verilating.rst | 5 ++-- docs/guide/warnings.rst | 5 ++-- docs/internals.rst | 19 ++++++------ docs/security.rst | 7 +++-- 38 files changed, 148 insertions(+), 109 deletions(-) diff --git a/README.rst b/README.rst index bec2182ad..8dd591838 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,8 @@ -.. Github doesn't render images unless absolute URL -.. Do not know of a conditional tag, "only: github" nor "github display" works -.. SPDX-FileCopyrightText: 2003-2026 Wilson Snyder -.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 +.. + Github doesn't render images unless absolute URL + Do not know of a conditional tag, "only: github" nor "github display" works + SPDX-FileCopyrightText: 2003-2026 Wilson Snyder + SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 |badge1| |badge2| |badge3| |badge4| |badge5| |badge7| |badge8| diff --git a/ci/docker/buildenv/README.rst b/ci/docker/buildenv/README.rst index 146725466..e1648420d 100644 --- a/ci/docker/buildenv/README.rst +++ b/ci/docker/buildenv/README.rst @@ -1,5 +1,6 @@ -.. SPDX-FileCopyrightText: 2003-2026 Wilson Snyder -.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 +.. + SPDX-FileCopyrightText: 2003-2026 Wilson Snyder + SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. _verilator build docker container: diff --git a/ci/docker/run/README.rst b/ci/docker/run/README.rst index 1ef7f9fb4..4feaf0804 100644 --- a/ci/docker/run/README.rst +++ b/ci/docker/run/README.rst @@ -1,5 +1,6 @@ -.. SPDX-FileCopyrightText: 2003-2026 Wilson Snyder -.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 +.. + SPDX-FileCopyrightText: 2003-2026 Wilson Snyder + SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 Verilator Executable Docker Container ===================================== diff --git a/docs/CONTRIBUTING.rst b/docs/CONTRIBUTING.rst index 6567d22b4..bec0684c6 100644 --- a/docs/CONTRIBUTING.rst +++ b/docs/CONTRIBUTING.rst @@ -1,5 +1,6 @@ -.. SPDX-FileCopyrightText: 2003-2026 Wilson Snyder -.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 +.. + SPDX-FileCopyrightText: 2003-2026 Wilson Snyder + SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 Contributing to Verilator ========================= diff --git a/docs/README.rst b/docs/README.rst index 5ace9194a..706619968 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -1,5 +1,6 @@ -.. SPDX-FileCopyrightText: 2003-2026 Wilson Snyder -.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 +.. + SPDX-FileCopyrightText: 2003-2026 Wilson Snyder + SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 Verilator Documentation ======================= diff --git a/docs/guide/changes.rst b/docs/guide/changes.rst index 09264212b..743fc77b9 100644 --- a/docs/guide/changes.rst +++ b/docs/guide/changes.rst @@ -1,5 +1,6 @@ -.. SPDX-FileCopyrightText: 2003-2026 Wilson Snyder -.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 +.. + SPDX-FileCopyrightText: 2003-2026 Wilson Snyder + SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 **************** Revision History diff --git a/docs/guide/connecting.rst b/docs/guide/connecting.rst index 65640aee9..67cad4ef3 100644 --- a/docs/guide/connecting.rst +++ b/docs/guide/connecting.rst @@ -1,5 +1,6 @@ -.. SPDX-FileCopyrightText: 2003-2026 Wilson Snyder -.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 +.. + SPDX-FileCopyrightText: 2003-2026 Wilson Snyder + SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. _connecting: diff --git a/docs/guide/contributing.rst b/docs/guide/contributing.rst index 9975c7512..3a2e57e81 100644 --- a/docs/guide/contributing.rst +++ b/docs/guide/contributing.rst @@ -1,5 +1,6 @@ -.. SPDX-FileCopyrightText: 2003-2026 Wilson Snyder -.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 +.. + SPDX-FileCopyrightText: 2003-2026 Wilson Snyder + SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 ******************************* Contributing and Reporting Bugs diff --git a/docs/guide/contributors.rst b/docs/guide/contributors.rst index 782a79865..2d31c91c8 100644 --- a/docs/guide/contributors.rst +++ b/docs/guide/contributors.rst @@ -1,5 +1,6 @@ -.. SPDX-FileCopyrightText: 2003-2026 Wilson Snyder -.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 +.. + SPDX-FileCopyrightText: 2003-2026 Wilson Snyder + SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 ************************ Contributors and Origins diff --git a/docs/guide/control.rst b/docs/guide/control.rst index c26159d56..8553de997 100644 --- a/docs/guide/control.rst +++ b/docs/guide/control.rst @@ -1,5 +1,6 @@ -.. SPDX-FileCopyrightText: 2003-2026 Wilson Snyder -.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 +.. + SPDX-FileCopyrightText: 2003-2026 Wilson Snyder + SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. _verilator control files: diff --git a/docs/guide/copyright.rst b/docs/guide/copyright.rst index 75b00d4ab..b5a59e1fe 100644 --- a/docs/guide/copyright.rst +++ b/docs/guide/copyright.rst @@ -1,5 +1,6 @@ -.. SPDX-FileCopyrightText: 2003-2026 Wilson Snyder -.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 +.. + SPDX-FileCopyrightText: 2003-2026 Wilson Snyder + SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 ********* Copyright diff --git a/docs/guide/deprecations.rst b/docs/guide/deprecations.rst index 75cad0492..7d69ab1c2 100644 --- a/docs/guide/deprecations.rst +++ b/docs/guide/deprecations.rst @@ -1,5 +1,6 @@ -.. SPDX-FileCopyrightText: 2003-2026 Wilson Snyder -.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 +.. + SPDX-FileCopyrightText: 2003-2026 Wilson Snyder + SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 Deprecations ============ diff --git a/docs/guide/environment.rst b/docs/guide/environment.rst index 1b3fd5ed4..a66ebe755 100644 --- a/docs/guide/environment.rst +++ b/docs/guide/environment.rst @@ -1,5 +1,6 @@ -.. SPDX-FileCopyrightText: 2003-2026 Wilson Snyder -.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 +.. + SPDX-FileCopyrightText: 2003-2026 Wilson Snyder + SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. _environment: diff --git a/docs/guide/example_binary.rst b/docs/guide/example_binary.rst index fd36fe8ce..c02469907 100644 --- a/docs/guide/example_binary.rst +++ b/docs/guide/example_binary.rst @@ -1,5 +1,6 @@ -.. SPDX-FileCopyrightText: 2003-2026 Wilson Snyder -.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 +.. + SPDX-FileCopyrightText: 2003-2026 Wilson Snyder + SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. _example create-binary execution: diff --git a/docs/guide/example_cc.rst b/docs/guide/example_cc.rst index 2a8384e85..d50caaa1d 100644 --- a/docs/guide/example_cc.rst +++ b/docs/guide/example_cc.rst @@ -1,5 +1,6 @@ -.. SPDX-FileCopyrightText: 2003-2026 Wilson Snyder -.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 +.. + SPDX-FileCopyrightText: 2003-2026 Wilson Snyder + SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. _example c++ execution: diff --git a/docs/guide/example_common_install.rst b/docs/guide/example_common_install.rst index 0e38fa6ff..1c963f39d 100644 --- a/docs/guide/example_common_install.rst +++ b/docs/guide/example_common_install.rst @@ -1,5 +1,6 @@ -.. SPDX-FileCopyrightText: 2003-2026 Wilson Snyder -.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 +.. + SPDX-FileCopyrightText: 2003-2026 Wilson Snyder + SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 First you need Verilator installed, see :ref:`Installation`. In brief, if you installed Verilator using the package manager of your operating system, diff --git a/docs/guide/example_dist.rst b/docs/guide/example_dist.rst index f3e1765f5..8427394c0 100644 --- a/docs/guide/example_dist.rst +++ b/docs/guide/example_dist.rst @@ -1,5 +1,6 @@ -.. SPDX-FileCopyrightText: 2003-2026 Wilson Snyder -.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 +.. + SPDX-FileCopyrightText: 2003-2026 Wilson Snyder + SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. _examples in the distribution: diff --git a/docs/guide/example_sc.rst b/docs/guide/example_sc.rst index 349645080..06ec49070 100644 --- a/docs/guide/example_sc.rst +++ b/docs/guide/example_sc.rst @@ -1,5 +1,6 @@ -.. SPDX-FileCopyrightText: 2003-2026 Wilson Snyder -.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 +.. + SPDX-FileCopyrightText: 2003-2026 Wilson Snyder + SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. _example systemc execution: diff --git a/docs/guide/examples.rst b/docs/guide/examples.rst index 5e0b2e260..1702ac513 100644 --- a/docs/guide/examples.rst +++ b/docs/guide/examples.rst @@ -1,5 +1,6 @@ -.. SPDX-FileCopyrightText: 2003-2026 Wilson Snyder -.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 +.. + SPDX-FileCopyrightText: 2003-2026 Wilson Snyder + SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. _examples: diff --git a/docs/guide/exe_sim.rst b/docs/guide/exe_sim.rst index 14fecf63e..ac2b73f16 100644 --- a/docs/guide/exe_sim.rst +++ b/docs/guide/exe_sim.rst @@ -1,5 +1,6 @@ -.. SPDX-FileCopyrightText: 2003-2026 Wilson Snyder -.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 +.. + SPDX-FileCopyrightText: 2003-2026 Wilson Snyder + SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. _simulation runtime arguments: @@ -50,8 +51,8 @@ Options: .. option:: +verilator+log+file+ - Log all stdout and stderr to the specified output filename. If not specified - the normal stdout/stderr streams are used. + Log all stdout and stderr to the specified output filename. If not specified + the normal stdout/stderr streams are used. .. option:: +verilator+noassert diff --git a/docs/guide/exe_verilator.rst b/docs/guide/exe_verilator.rst index 72da2961f..2be7d5bf4 100644 --- a/docs/guide/exe_verilator.rst +++ b/docs/guide/exe_verilator.rst @@ -1,5 +1,6 @@ -.. SPDX-FileCopyrightText: 2003-2026 Wilson Snyder -.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 +.. + SPDX-FileCopyrightText: 2003-2026 Wilson Snyder + SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 =================== verilator Arguments @@ -669,7 +670,7 @@ Summary: .. option:: -fno-case-tree - Rarely needed. Disable converting case statements into bitwise branch trees. + Rarely needed. Disable converting case statements into bit-wise branch trees. .. option:: -fno-combine diff --git a/docs/guide/exe_verilator_coverage.rst b/docs/guide/exe_verilator_coverage.rst index b5f0598c2..388f67cfb 100644 --- a/docs/guide/exe_verilator_coverage.rst +++ b/docs/guide/exe_verilator_coverage.rst @@ -1,5 +1,6 @@ -.. SPDX-FileCopyrightText: 2003-2026 Wilson Snyder -.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 +.. + SPDX-FileCopyrightText: 2003-2026 Wilson Snyder + SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 verilator_coverage ================== diff --git a/docs/guide/exe_verilator_gantt.rst b/docs/guide/exe_verilator_gantt.rst index 5b45969f9..b9944575c 100644 --- a/docs/guide/exe_verilator_gantt.rst +++ b/docs/guide/exe_verilator_gantt.rst @@ -1,5 +1,6 @@ -.. SPDX-FileCopyrightText: 2003-2026 Wilson Snyder -.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 +.. + SPDX-FileCopyrightText: 2003-2026 Wilson Snyder + SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 verilator_gantt =============== diff --git a/docs/guide/exe_verilator_profcfunc.rst b/docs/guide/exe_verilator_profcfunc.rst index c79f86436..a29a5a34c 100644 --- a/docs/guide/exe_verilator_profcfunc.rst +++ b/docs/guide/exe_verilator_profcfunc.rst @@ -1,5 +1,6 @@ -.. SPDX-FileCopyrightText: 2003-2026 Wilson Snyder -.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 +.. + SPDX-FileCopyrightText: 2003-2026 Wilson Snyder + SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 verilator_profcfunc =================== diff --git a/docs/guide/executables.rst b/docs/guide/executables.rst index ac4e3f85e..7d86091b5 100644 --- a/docs/guide/executables.rst +++ b/docs/guide/executables.rst @@ -1,5 +1,6 @@ -.. SPDX-FileCopyrightText: 2003-2026 Wilson Snyder -.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 +.. + SPDX-FileCopyrightText: 2003-2026 Wilson Snyder + SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 ********************************* Executable and Argument Reference diff --git a/docs/guide/extensions.rst b/docs/guide/extensions.rst index 4ea636af0..8e8d5d183 100644 --- a/docs/guide/extensions.rst +++ b/docs/guide/extensions.rst @@ -1,5 +1,6 @@ -.. SPDX-FileCopyrightText: 2003-2026 Wilson Snyder -.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 +.. + SPDX-FileCopyrightText: 2003-2026 Wilson Snyder + SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 =================== Language Extensions diff --git a/docs/guide/faq.rst b/docs/guide/faq.rst index ec55a9a9c..e0b184385 100644 --- a/docs/guide/faq.rst +++ b/docs/guide/faq.rst @@ -1,5 +1,6 @@ -.. SPDX-FileCopyrightText: 2003-2026 Wilson Snyder -.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 +.. + SPDX-FileCopyrightText: 2003-2026 Wilson Snyder + SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 ****************************** FAQ/Frequently Asked Questions diff --git a/docs/guide/files.rst b/docs/guide/files.rst index 2e5fa2225..d50b291df 100644 --- a/docs/guide/files.rst +++ b/docs/guide/files.rst @@ -1,5 +1,6 @@ -.. SPDX-FileCopyrightText: 2003-2026 Wilson Snyder -.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 +.. + SPDX-FileCopyrightText: 2003-2026 Wilson Snyder + SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 ***** Files @@ -163,9 +164,11 @@ The Verilated executable may produce the following: .. list-table:: * - coverage.dat - - Code coverage output, and default input filename for :command:`verilator_coverage` + - Code coverage output, and default input filename for + :command:`verilator_coverage` * - gmon.out - - GCC/clang code profiler output, often fed into :command:`verilator_profcfunc` + - GCC/clang code profiler output, often fed into + :command:`verilator_profcfunc` * - profile.vlt - --prof-pgo data file for :ref:`Thread PGO` * - profile_exec.dat diff --git a/docs/guide/index.rst b/docs/guide/index.rst index 5df45c271..8b7271352 100644 --- a/docs/guide/index.rst +++ b/docs/guide/index.rst @@ -1,5 +1,6 @@ -.. SPDX-FileCopyrightText: 2003-2026 Wilson Snyder -.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 +.. + SPDX-FileCopyrightText: 2003-2026 Wilson Snyder + SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 ###################### Verilator User's Guide diff --git a/docs/guide/install-cmake.rst b/docs/guide/install-cmake.rst index 03566ac01..56723842b 100644 --- a/docs/guide/install-cmake.rst +++ b/docs/guide/install-cmake.rst @@ -1,5 +1,6 @@ -.. SPDX-FileCopyrightText: 2003-2026 Wilson Snyder -.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 +.. + SPDX-FileCopyrightText: 2003-2026 Wilson Snyder + SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. _cmakeinstallation: diff --git a/docs/guide/install.rst b/docs/guide/install.rst index 09a58a94f..59b29b2cf 100644 --- a/docs/guide/install.rst +++ b/docs/guide/install.rst @@ -1,5 +1,6 @@ -.. SPDX-FileCopyrightText: 2003-2026 Wilson Snyder -.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 +.. + SPDX-FileCopyrightText: 2003-2026 Wilson Snyder + SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. _installation: diff --git a/docs/guide/languages.rst b/docs/guide/languages.rst index 04fb44ba4..b0d2f57f5 100644 --- a/docs/guide/languages.rst +++ b/docs/guide/languages.rst @@ -1,5 +1,6 @@ -.. SPDX-FileCopyrightText: 2003-2026 Wilson Snyder -.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 +.. + SPDX-FileCopyrightText: 2003-2026 Wilson Snyder + SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 *************** Input Languages diff --git a/docs/guide/overview.rst b/docs/guide/overview.rst index 5ffe52ed2..7bd01c1b8 100644 --- a/docs/guide/overview.rst +++ b/docs/guide/overview.rst @@ -1,5 +1,6 @@ -.. SPDX-FileCopyrightText: 2003-2026 Wilson Snyder -.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 +.. + SPDX-FileCopyrightText: 2003-2026 Wilson Snyder + SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 ******** Overview diff --git a/docs/guide/simulating.rst b/docs/guide/simulating.rst index 89baf9ccc..168a02414 100644 --- a/docs/guide/simulating.rst +++ b/docs/guide/simulating.rst @@ -1,5 +1,6 @@ -.. SPDX-FileCopyrightText: 2003-2026 Wilson Snyder -.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 +.. + SPDX-FileCopyrightText: 2003-2026 Wilson Snyder + SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. _simulating: @@ -218,8 +219,8 @@ Covergroup Coverage With :vlopt:`--coverage` or :vlopt:`--coverage-user`, Verilator will translate covergroup coverage points the user has inserted manually in -SystemVerilog code into the Verilated model. Verilator supports -coverpoints with value and transition bins, and cross points. +SystemVerilog code into the Verilated model. Verilator supports coverpoints +with value and transition bins, and cross points. .. _fsm coverage: @@ -244,15 +245,15 @@ encodings in these common forms: - Single-process FSMs, whose state dispatch is written as ``case (state)`` or as a top-level ``if`` / ``else if`` chain comparing the same state variable against known state values -- Two-process and three-block FSMs, where a clocked state register is paired - with a combinational next-state block using the same supported +- Two-process and three-block FSMs, where a clocked state register is + paired with a combinational next-state block using the same supported ``case`` or top-level ``if`` / ``else if`` dispatch forms -Scalar state encodings may be wider than 32 bits. This allows sparse -state encodings, such as high-Hamming-distance enum or localparam values, -to be preserved in the detected FSM model. Verilator uses the declared -enum item name, parameter name, or localparam name as the reported state -label where possible. +Scalar state encodings may be wider than 32 bits. This allows sparse state +encodings, such as high-Hamming-distance enum or localparam values, to be +preserved in the detected FSM model. Verilator uses the declared enum item +name, parameter name, or localparam name as the reported state label where +possible. Simple input guards are supported when they appear inside a recognized state branch, or as a top-level conjunction containing exactly one state @@ -275,10 +276,10 @@ the extracted coverage model: - ``/*verilator fsm_arc_include_cond*/`` keeps conditional branch arcs that would otherwise be skipped by the conservative extractor. -State registers may also be wrapped by a transparent instance, for -example a project flop wrapper or primitive. Such wrappers must be -described explicitly with a VLT command file action before Verilator will -use their data, state, clock, or reset connections for FSM extraction: +State registers may also be wrapped by a transparent instance, for example +a project flop wrapper or primitive. Such wrappers must be described +explicitly with a VLT command file action before Verilator will use their +data, state, clock, or reset connections for FSM extraction: .. code-block:: sv @@ -298,11 +299,10 @@ Optional reset metadata may also be supplied: fsm_register_wrapper -module "my_fsm_flop" -d "state_i" -q "state_o" -clock "clk_i" \ -reset "rst_ni" -reset_value "ResetValue" -Reset arcs are emitted only when the configured reset port has an -inferable edge in the wrapper and the configured reset value parameter is -statically resolvable. If reset metadata is incomplete, Verilator warns -and may still emit FSM state and transition coverage, but reset arcs are -omitted. +Reset arcs are emitted only when the configured reset port has an inferable +edge in the wrapper and the configured reset value parameter is statically +resolvable. If reset metadata is incomplete, Verilator warns and may still +emit FSM state and transition coverage, but reset arcs are omitted. Reset transitions are included in the collected data either way. By default, :command:`verilator_coverage` summarizes reset-only arcs rather diff --git a/docs/guide/verilating.rst b/docs/guide/verilating.rst index 977d73c38..65a6f2d07 100644 --- a/docs/guide/verilating.rst +++ b/docs/guide/verilating.rst @@ -1,5 +1,6 @@ -.. SPDX-FileCopyrightText: 2003-2026 Wilson Snyder -.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 +.. + SPDX-FileCopyrightText: 2003-2026 Wilson Snyder + SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 ********** Verilating diff --git a/docs/guide/warnings.rst b/docs/guide/warnings.rst index db41d8405..209a52ebb 100644 --- a/docs/guide/warnings.rst +++ b/docs/guide/warnings.rst @@ -1,5 +1,6 @@ -.. SPDX-FileCopyrightText: 2003-2026 Wilson Snyder -.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 +.. + SPDX-FileCopyrightText: 2003-2026 Wilson Snyder + SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 =================== Errors and Warnings diff --git a/docs/internals.rst b/docs/internals.rst index 7b86beff6..241c4b14a 100644 --- a/docs/internals.rst +++ b/docs/internals.rst @@ -732,8 +732,8 @@ event `a` was called first - which is necessary to know. There are two functions for managing timing logic called by ``_eval()``: -* ``_timing_ready()``, which commits all coroutines whose triggers were - not set in the current iteration, +* ``_timing_ready()``, which commits all coroutines whose triggers were not + set in the current iteration, * ``_timing_resume()``, which calls `resume()` on all trigger and delay schedulers whose triggers were set in the current iteration. @@ -937,14 +937,15 @@ macro-task's dataset fits in one core's local caches. To achieve spatial locality, we tag each variable with the set of macro-tasks that access it. Let's call this set the "footprint" of that -variable. The variables in a given module have a set of footprints. We group -variables with identical non-empty footprints, emit those groups in deterministic -footprint-key order, then emit variables with no footprint information last. +variable. The variables in a given module have a set of footprints. We +group variables with identical non-empty footprints, emit those groups in +deterministic footprint-key order, then emit variables with no footprint +information last. -The first emitted variable in each footprint group is aligned to a cache-line -boundary. This avoids false sharing between different macro-task footprints -without building a complete pairwise-distance graph over all footprints, which -would use excessive memory on very large models. +The first emitted variable in each footprint group is aligned to a +cache-line boundary. This avoids false sharing between different macro-task +footprints without building a complete pairwise-distance graph over all +footprints, which would use excessive memory on very large models. This is an old idea. Simulators designed at DEC in the early 1990s used similar techniques to optimize both single-thread and multithread modes. diff --git a/docs/security.rst b/docs/security.rst index 4080bad92..3adb6c8d9 100644 --- a/docs/security.rst +++ b/docs/security.rst @@ -1,6 +1,7 @@ -.. for github, vim: syntax=reStructuredText -.. SPDX-FileCopyrightText: 2025-2026 Wilson Snyder -.. SPDX-License-Identifier: CC0-1.0 +.. + for github, vim: syntax=reStructuredText + SPDX-FileCopyrightText: 2025-2026 Wilson Snyder + SPDX-License-Identifier: CC0-1.0 Security Policy ===============