Commentary: Minor spelling fixes in docs/guide/*.rst (#3327)
This commit is contained in:
parent
47069dfe52
commit
72a3c756ad
|
|
@ -57,6 +57,7 @@ Keith Colbert
|
||||||
Kevin Kiningham
|
Kevin Kiningham
|
||||||
Krzysztof Bieganski
|
Krzysztof Bieganski
|
||||||
Kuba Ober
|
Kuba Ober
|
||||||
|
Larry Doolittle
|
||||||
Ludwig Rogiers
|
Ludwig Rogiers
|
||||||
Lukasz Dalek
|
Lukasz Dalek
|
||||||
Maarten De Braekeleer
|
Maarten De Braekeleer
|
||||||
|
|
|
||||||
|
|
@ -18,4 +18,4 @@ Verilated_heavy.h
|
||||||
|
|
||||||
Option `--cdc`
|
Option `--cdc`
|
||||||
The experimental `--cdc` option is believed to be generally unused and is
|
The experimental `--cdc` option is believed to be generally unused and is
|
||||||
planned for removeal no sooner than January 2023.
|
planned for removal no sooner than January 2023.
|
||||||
|
|
|
||||||
|
|
@ -884,7 +884,7 @@ Summary:
|
||||||
|
|
||||||
Using DPI imports/exports is allowed and generally relatively safe in
|
Using DPI imports/exports is allowed and generally relatively safe in
|
||||||
terms of information disclosed, which is limited to the DPI function
|
terms of information disclosed, which is limited to the DPI function
|
||||||
prototyptes. Use of the VPI is not recommended as many design details
|
prototypes. Use of the VPI is not recommended as many design details
|
||||||
may be exposed, and an INSECURE warning will be issued.
|
may be exposed, and an INSECURE warning will be issued.
|
||||||
|
|
||||||
.. option:: --protect-lib <name>
|
.. option:: --protect-lib <name>
|
||||||
|
|
@ -1514,7 +1514,7 @@ The grammar of configuration commands is as follows:
|
||||||
.. option:: no_clocker -module "<modulename>" [-function "<funcname>"] -var "<signame>"
|
.. option:: no_clocker -module "<modulename>" [-function "<funcname>"] -var "<signame>"
|
||||||
|
|
||||||
Indicates that the signal is used as clock or not. This information is
|
Indicates that the signal is used as clock or not. This information is
|
||||||
used by Verilator to mark the signal and any derrived signals as
|
used by Verilator to mark the signal and any derived signals as
|
||||||
clocker. See :vlopt:`--clk`.
|
clocker. See :vlopt:`--clk`.
|
||||||
|
|
||||||
Same as :option:`/*verilator&32;clocker*/` metacomment.
|
Same as :option:`/*verilator&32;clocker*/` metacomment.
|
||||||
|
|
|
||||||
|
|
@ -67,7 +67,7 @@ which have low coverage are written to the output directory.
|
||||||
|
|
||||||
Specifies if the coverage point does not include the count number of
|
Specifies if the coverage point does not include the count number of
|
||||||
coverage hits, then the coverage point will be considered above the
|
coverage hits, then the coverage point will be considered above the
|
||||||
threashold, and the coverage report will put a "%" to indicate the coverage
|
threshold, and the coverage report will put a "%" to indicate the coverage
|
||||||
is not sufficient. Defaults to 10.
|
is not sufficient. Defaults to 10.
|
||||||
|
|
||||||
.. option:: --help
|
.. option:: --help
|
||||||
|
|
|
||||||
|
|
@ -185,7 +185,7 @@ or "`ifdef`"'s may break other tools.
|
||||||
.. option:: /*verilator&32;no_clocker*/
|
.. option:: /*verilator&32;no_clocker*/
|
||||||
|
|
||||||
Specifies that the signal is used as clock or not. This information is
|
Specifies that the signal is used as clock or not. This information is
|
||||||
used by Verilator to mark the signal and any derrived signals as
|
used by Verilator to mark the signal and any derived signals as
|
||||||
clocker. See :vlopt:`--clk`.
|
clocker. See :vlopt:`--clk`.
|
||||||
|
|
||||||
Same as :option:`clocker` and :option:`no_clocker` in configuration
|
Same as :option:`clocker` and :option:`no_clocker` in configuration
|
||||||
|
|
|
||||||
|
|
@ -37,8 +37,8 @@ Does Verilator run under Windows?
|
||||||
|
|
||||||
Yes, ideally run Ubuntu under Windows Subsystem for Linux (WSL2).
|
Yes, ideally run Ubuntu under Windows Subsystem for Linux (WSL2).
|
||||||
Alternatively use Cygwin, though this tends to be slower and is not
|
Alternatively use Cygwin, though this tends to be slower and is not
|
||||||
regurally tested. Verilated output also compiles under Microsoft Visual
|
regularly tested. Verilated output also compiles under Microsoft Visual
|
||||||
C++, but this is also not regurally tested.
|
C++, but this is also not regularly tested.
|
||||||
|
|
||||||
|
|
||||||
Can you provide binaries?
|
Can you provide binaries?
|
||||||
|
|
|
||||||
|
|
@ -136,7 +136,7 @@ ___05F (5F is the hex code of an underscore.)
|
||||||
Bind
|
Bind
|
||||||
----
|
----
|
||||||
|
|
||||||
sVerilator only supports bind to a target module name, not to an
|
Verilator only supports bind to a target module name, not to an
|
||||||
instance path.
|
instance path.
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -518,7 +518,7 @@ List Of Warnings
|
||||||
Another way DIDNOTCONVERGE may occur is if # delays are used to generate
|
Another way DIDNOTCONVERGE may occur is if # delays are used to generate
|
||||||
clocks. Verilator ignores the delays and gives an :option:`ASSIGNDLY`
|
clocks. Verilator ignores the delays and gives an :option:`ASSIGNDLY`
|
||||||
or :option:`STMTDLY` warning. If these were suppressed, due to the
|
or :option:`STMTDLY` warning. If these were suppressed, due to the
|
||||||
absense of the delay, the code may now oscillate.
|
absence of the delay, the code may now oscillate.
|
||||||
|
|
||||||
Finally, rare, more difficult cases can be debugged like a C++ program;
|
Finally, rare, more difficult cases can be debugged like a C++ program;
|
||||||
either enter :command:`gdb` and use its tracing facilities, or edit the
|
either enter :command:`gdb` and use its tracing facilities, or edit the
|
||||||
|
|
@ -528,7 +528,7 @@ List Of Warnings
|
||||||
.. option:: ENDCAPSULATED
|
.. option:: ENDCAPSULATED
|
||||||
|
|
||||||
Warns that a class member is declared is local or protected, but is
|
Warns that a class member is declared is local or protected, but is
|
||||||
being accessed from outside that class (if local) or a derrived class
|
being accessed from outside that class (if local) or a derived class
|
||||||
(if protected).
|
(if protected).
|
||||||
|
|
||||||
Ignoring this warning will only suppress the lint check, it will
|
Ignoring this warning will only suppress the lint check, it will
|
||||||
|
|
@ -924,7 +924,7 @@ List Of Warnings
|
||||||
simulate correctly.
|
simulate correctly.
|
||||||
|
|
||||||
Other tools with similar warnings: Icarus Verilog's portbind, "warning:
|
Other tools with similar warnings: Icarus Verilog's portbind, "warning:
|
||||||
Instantiating module ... with dangling impot port (...)". Slang's
|
Instantiating module ... with dangling input port (...)". Slang's
|
||||||
unconnected-port, "port '...' has no connection".
|
unconnected-port, "port '...' has no connection".
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue