From 90009b9ec717efbbad6e355433ac010fc91ca045 Mon Sep 17 00:00:00 2001 From: Wilson Snyder Date: Sun, 2 Oct 2022 16:47:32 -0400 Subject: [PATCH] Commentary: Fix sphinx doc warnings --- docs/guide/connecting.rst | 1 + docs/guide/example_binary.rst | 8 ++++---- docs/guide/exe_sim.rst | 2 +- docs/guide/exe_verilator.rst | 4 ++-- 4 files changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/guide/connecting.rst b/docs/guide/connecting.rst index beb3ad774..876f15487 100644 --- a/docs/guide/connecting.rst +++ b/docs/guide/connecting.rst @@ -451,6 +451,7 @@ the user should call: * :code:`designp->nextTimeSlot()`, which returns the simulation time of the next delayed event. This method can only be called if :code:`designp->nextTimeSlot()` returned :code:`true`. + Call :code:`eventsPending()` to check if you should continue with the simulation, and then :code:`nextTimeSlot()` to move simulation time forward. :vlopt:`--main` can be used with :vlopt:`--timing` to generate a basic example diff --git a/docs/guide/example_binary.rst b/docs/guide/example_binary.rst index ba88fc3ad..974471c7a 100644 --- a/docs/guide/example_binary.rst +++ b/docs/guide/example_binary.rst @@ -1,10 +1,10 @@ .. Copyright 2003-2022 by Wilson Snyder. .. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 -.. _Example C++ Execution: +.. _Example Create-Binary Execution: -Example C++ Execution -===================== +Example Create-Binary Execution +=============================== We'll compile this SystemC example into a Verilated simulation binary. For an example that discusses the next level of detail see :ref:`Example C++ @@ -36,7 +36,7 @@ Breaking this command down: #. :vlopt:`--binary` telling Verilator to do everything needed to create a simulation executable. -#. :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. #. :vlopt:`-Wall` so Verilator has stronger lint warnings diff --git a/docs/guide/exe_sim.rst b/docs/guide/exe_sim.rst index 364ac5fba..03dd1d76e 100644 --- a/docs/guide/exe_sim.rst +++ b/docs/guide/exe_sim.rst @@ -72,7 +72,7 @@ Summary: .. option:: +verilator+prof+threads+window+ - Deprecated. Alias for :vlopt:`+verilator+prof+exec+window+\` + Deprecated. Alias for :vlopt:`+verilator+prof+exec+window+\` .. option:: +verilator+prof+vlt+file+ diff --git a/docs/guide/exe_verilator.rst b/docs/guide/exe_verilator.rst index 2a529ca53..d06d8ae12 100644 --- a/docs/guide/exe_verilator.rst +++ b/docs/guide/exe_verilator.rst @@ -421,8 +421,8 @@ Summary: Rarely needed - for developer use. Set the dumping level in the specified Verilator source file to the specified value (e.g. - :vlopt:`--dumpi-V3Order 9`). Level 0 disables dumps and is equivalent - to :vlopt:`--no-dump-`. Level 9 enables dumping of everything. + `--dumpi-V3Order 9`). Level 0 disables dumps and is equivalent to + `--no-dump-`. Level 9 enables dumping of everything. .. option:: -E