From 429cb1f7f726ccad3b933e899ac255b806948d92 Mon Sep 17 00:00:00 2001 From: Wilson Snyder Date: Sat, 23 Sep 2023 09:04:35 -0400 Subject: [PATCH] Commentary (#4517) --- docs/guide/environment.rst | 21 +++++++++++++++++++++ docs/internals.rst | 4 ++-- docs/spelling.txt | 1 + 3 files changed, 24 insertions(+), 2 deletions(-) diff --git a/docs/guide/environment.rst b/docs/guide/environment.rst index a8e4b44391..4cfe4c535e 100644 --- a/docs/guide/environment.rst +++ b/docs/guide/environment.rst @@ -7,6 +7,21 @@ Environment This section describes the environment variables used by Verilator and associated programs. +.. option:: AR + + Optionally overrides the default :command:`ar` (archive) binary used by + the Verilated makefiles. If AR is not set, the version found at + configure time is used. + +.. option:: CXX + + Optionally overrides the default compiler binary used by the Verilated + makefiles. If CXX is not set, the version found at configure time is + used. Note the default flags passed to the compiler are determined at + configuration time, so changing the CXX compiler version using this + variable, as opposed to passing it at configuration time, may not give + desired results. + .. option:: LD_LIBRARY_PATH A generic Linux/OS variable specifying what directories have shared @@ -35,6 +50,12 @@ associated programs. those programs. If OBJCACHE is not set, and at configure time ccache was present, ccache will be used as a default. +.. option:: PYTHON3 + + Optionally overrides the default :command:`python3` binary used by the + Verilated makefiles. If PYTHON3 is not set, the version found at + configure time is used. + .. option:: SYSTEMC Deprecated. Used only if :option:`SYSTEMC_INCLUDE` or diff --git a/docs/internals.rst b/docs/internals.rst index 136c902656..d03eebd171 100644 --- a/docs/internals.rst +++ b/docs/internals.rst @@ -1400,7 +1400,7 @@ Controlling the Test Driver --------------------------- The test driver script `driver.pl` runs tests; see the `Test Driver` -section. The individual test drivers are written in PERL; see `Test +section. The individual test drivers are written in Perl; see `Test Language`. @@ -1432,7 +1432,7 @@ Developers will also want to call ./configure with two extra flags: disabled by default, as SystemC installation problems would otherwise falsely indicate a Verilator problem. -When enabling the long tests, some additional PERL modules are needed, +When enabling the long tests, some additional Perl modules are needed, which you can install using cpan. :: diff --git a/docs/spelling.txt b/docs/spelling.txt index cddf6a1b2e..d55530c502 100644 --- a/docs/spelling.txt +++ b/docs/spelling.txt @@ -486,6 +486,7 @@ countbits countones cout cpp +cppstyle cpu ctor ctrace