From 25ca965938e63ff7d85d16f2d69eed98a91f0bd1 Mon Sep 17 00:00:00 2001 From: Wilson Snyder Date: Tue, 21 Nov 2023 19:17:39 -0500 Subject: [PATCH] Commentary --- docs/guide/contributors.rst | 2 +- docs/guide/exe_verilator.rst | 14 +++++++------- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/guide/contributors.rst b/docs/guide/contributors.rst index b00fc1b46..5a7f9338c 100644 --- a/docs/guide/contributors.rst +++ b/docs/guide/contributors.rst @@ -157,7 +157,7 @@ Winkel, Jeff Winston, Joshua Wise, Clifford Wolf, Johan Wouters, Paul Wright, Tobias Wölfel, Junyi Xi, Ding Xiaoliang, Liu Xiaoyi, Mandy Xu, Shanshan Xu, Yinan Xu, SU YANG, Felix Yan, Luke Yang, Amir Yazdanbakhsh, Chentai (Seven) Yuan, Florian Zaruba, Mat Zeno, Keyi Zhang, Xi Zhang, Yike -Zhou, Jiamin Zhu, and Исаак Алексеевич. +Zhou, Jiamin Zhu. Thanks to them, and all those we've missed mentioning above, and to those whom have wished to remain anonymous. diff --git a/docs/guide/exe_verilator.rst b/docs/guide/exe_verilator.rst index aed8a4806..5db278a79 100644 --- a/docs/guide/exe_verilator.rst +++ b/docs/guide/exe_verilator.rst @@ -1363,13 +1363,13 @@ Summary: Enable FST waveform tracing in the model. This overrides :vlopt:`--trace`. See also :vlopt:`--trace-threads` option. -.. option:: --trace-max-array *depth* +.. option:: --trace-max-array Rarely needed. Specify the maximum array depth of a signal that may be traced. Defaults to 32, as tracing large arrays may greatly slow traced simulations. -.. option:: --trace-max-width *width* +.. option:: --trace-max-width Rarely needed. Specify the maximum bit width of a signal that may be traced. Defaults to 256, as tracing large vectors may greatly slow @@ -1386,7 +1386,7 @@ Summary: format constraints, this may result in significantly slower trace times and larger trace files. -.. option:: --trace-threads *threads* +.. option:: --trace-threads Enable waveform tracing using separate threads. This is typically faster in simulation runtime but uses more total compute. This option only @@ -1427,12 +1427,12 @@ Summary: Rarely needed. Specifies the maximum number of loop iterations that may be unrolled. See also :option:`BLKLOOPINIT` warning. -.. option:: --unroll-stmts *statements* +.. option:: --unroll-stmts Rarely needed. Specifies the maximum number of statements in a loop for that loop to be unrolled. See also :option:`BLKLOOPINIT` warning. -.. option:: --unused-regexp *regexp* +.. option:: --unused-regexp Rarely needed. Specifies a simple regexp with \* and ? that, if a signal name matches, will suppress the :option:`UNUSED` warning. Defaults to @@ -1444,7 +1444,7 @@ Summary: into Verilator. (Similar to :command:`perl -V`.) See also :vlopt:`--getenv` option. -.. option:: -v *filename* +.. option:: -v Read the filename as a Verilog library. Any modules in the file may be used to resolve instances in the top-level module, otherwise, they are @@ -1481,7 +1481,7 @@ Summary: Enable the use of VPI and linking against the :file:`verilated_vpi.cpp` files. -.. option:: --waiver-output *filename* +.. option:: --waiver-output Generate a waiver file that contains all waiver statements to suppress the warnings emitted during this Verilator run. This, in particular, is