Commentary

This commit is contained in:
Wilson Snyder 2019-10-19 07:08:18 -04:00
parent 712bc43a06
commit e15d3afb7b
3 changed files with 15 additions and 15 deletions

View File

@ -1064,9 +1064,9 @@ at the next function boundary. In addition, any infrequently executed
"cold" routines will be placed into __Slow files. This accelerates "cold" routines will be placed into __Slow files. This accelerates
compilation by as optimization can be disabled on the routines in __Slow, compilation by as optimization can be disabled on the routines in __Slow,
and the remaining files can be compiled on parallel machines. Using and the remaining files can be compiled on parallel machines. Using
--output-split should have only a trivial impact on performance. With GCC --output-split should have only a trivial impact on performance. On one
3.3 on a 2GHz Opteron, --output-split 20000 will result in splitting into design --output-split 20000 resulted in splitting into approximately
approximately one-minute-compile chunks. one-minute-compile chunks.
=item --output-split-cfuncs I<statements> =item --output-split-cfuncs I<statements>
@ -1429,7 +1429,7 @@ Disable tracing of parameters.
=item --trace-structs =item --trace-structs
Enable tracing to show the name of packed structure, union, and packed Enable tracing to show the name of packed structure, union, and packed
array fields, rather than a simgle combined packed bus. Due to VCD file array fields, rather than a single combined packed bus. Due to VCD file
format constraints this may result in significantly slower trace times and format constraints this may result in significantly slower trace times and
larger trace files. larger trace files.
@ -2517,7 +2517,7 @@ List of verilog files to Verilate. Must have at least one file.
Optional. Sets the Verilator output prefix. Defaults to the name of the Optional. Sets the Verilator output prefix. Defaults to the name of the
first hdl source with a "V" prepended. Must be unique in each call to first hdl source with a "V" prepended. Must be unique in each call to
verilate(), so this is necessary if you build a module multiple times with verilate(), so this is necessary if you build a module multiple times with
different parameters. Must be a valid C++ identifer, i.e. contains no different parameters. Must be a valid C++ identifier, i.e. contains no
whitespace and only characters A-Z, a-z, 0-9 or _. whitespace and only characters A-Z, a-z, 0-9 or _.
=item TOP_MODULE =item TOP_MODULE
@ -2548,7 +2548,7 @@ Optional. Sets directories that Verilator searches (same as -y).
=item OPT_SLOW =item OPT_SLOW
Optional. Set compiler flags for the slow path. You may want to reduce the Optional. Set compiler flags for the slow path. You may want to reduce the
optimisation level to improve compile times with large designs. optimization level to improve compile times with large designs.
=item OPT_FAST =item OPT_FAST
@ -3821,7 +3821,7 @@ correctly.
Error when Verilator tries to deal with a combinatorial loop that could not be Error when Verilator tries to deal with a combinatorial loop that could not be
flattened, and which involves a datatype which Verilator cannot handle, such flattened, and which involves a datatype which Verilator cannot handle, such
as an unpacked struct or a large unpacked array. This typically ocurrs when as an unpacked struct or a large unpacked array. This typically occurs when
-Wno-UNOPTFLAT has been used to override an UNOPTFLAT warning (see below). -Wno-UNOPTFLAT has been used to override an UNOPTFLAT warning (see below).
The solution is to break the loop, as described for UNOPTFLAT. The solution is to break the loop, as described for UNOPTFLAT.
@ -4262,8 +4262,8 @@ correctly.
=item UNUSED =item UNUSED
Warns that the specified signal is never sinked. Verilator is fairly Warns that the specified signal is never used/consumed. Verilator is
liberal in the usage calculations; making a signal public, a signal fairly liberal in the usage calculations; making a signal public, a signal
matching --unused-regexp ("*unused*") or accessing only a single array matching --unused-regexp ("*unused*") or accessing only a single array
element marks the entire signal as used. element marks the entire signal as used.

View File

@ -25,11 +25,11 @@ contributions flow more efficiently.
* Please https://www.veripool.org/projects/verilator/issues/new[Open a new * Please https://www.veripool.org/projects/verilator/issues/new[Open a new
issue]. issue].
* You may attach a patch to the issue, or (preferred) may point to a github * You may attach a patch to the issue, or (preferred) may point to a GitHub
repository branch within your github account. repository branch within your GitHub account.
** Verilator uses Travis CI to provide continuous integration. You may ** Verilator uses Travis CI to provide continuous integration. You may
want to setup Travis CI on your github branch to ensure your changes want to setup Travis CI on your GitHub branch to ensure your changes
keep the tests passing. See link:internals.adoc[docs/internals]. keep the tests passing. See link:internals.adoc[docs/internals].
* Your source-code contributions must be certified as open source, under * Your source-code contributions must be certified as open source, under
@ -48,7 +48,7 @@ contributions flow more efficiently.
contributions. contributions.
** In any of these cases your name will be added to ** In any of these cases your name will be added to
link:CONTRIBUTORS[docs/CONTRIBUTRORS] and you are agreeing all future link:CONTRIBUTORS[docs/CONTRIBUTORS] and you are agreeing all future
contributions are also certified. contributions are also certified.
** We occasionally accept contributions where people do not want their ** We occasionally accept contributions where people do not want their

View File

@ -404,7 +404,7 @@ style indentation; the `c-set-style` undoes that.)
* No spaces before semicolons, nor between a function's name and open * No spaces before semicolons, nor between a function's name and open
parenthesis (only applies to functions; if/else has a following space). parenthesis (only applies to functions; if/else has a following space).
* Use "mixedCapsSymbols" instead of "underlined_symbls". * Use "mixedCapsSymbols" instead of "underlined_symbols".
* Comment every member variable. * Comment every member variable.
@ -712,7 +712,7 @@ also runs a daily cron job to validate all of the tests against different OS and
compiler versions. compiler versions.
Developers can connect Travis CI to their GitHub account so that the CI Developers can connect Travis CI to their GitHub account so that the CI
enviroment can check their branches too by doing the following: environment can check their branches too by doing the following:
* Go to https://github.com/marketplace/travis-ci and follow the prompts * Go to https://github.com/marketplace/travis-ci and follow the prompts