ivtest: Document the ivest/regress-vNN.list file.

This is another bit that needs to be accounted for when changing versions.
This commit is contained in:
Stephen Williams 2022-12-26 19:33:26 -05:00
parent e088bee091
commit a7c5eceeea
1 changed files with 14 additions and 6 deletions

View File

@ -12,18 +12,26 @@ When versions are changed, the above files need to be edited to account for
the new version information. The following used to have verion information in the new version information. The following used to have verion information in
them, but now their version information is generated: them, but now their version information is generated:
Replaced with version_base.h, which is edited manually, and The version_tag.h file is generated from git tag information using
version_tag.h which is generated from git tag information. the "make version" target, or automatically if the version_tag.h
file doesn't exist at all. This implies that a "make version" is
something worth doing when you do a "git pull" or create commits.
* version-base.in -- Most compiled code gets version from here The files below are now edited by the makefile and the version.exe program:
These are now edited by the makefile and the version.exe program.
* iverilog-vpi.man -- The .TH tag has a version string * iverilog-vpi.man -- The .TH tag has a version string
* driver/iverilog.man -- The .TH tag has a version string * driver/iverilog.man -- The .TH tag has a version string
* driver-vpi/res.rc -- Used to build Windows version stamp * driver-vpi/res.rc -- Used to build Windows version stamp
* vvp/vvp.man -- The .TH tag has a version string * vvp/vvp.man -- The .TH tag has a version string
This now includes version_base.h to get the version This now includes version_base.h to get the version:
* vpi/vams_simparam.c -- Hard coded result to simulatorVersion query * vpi/vams_simparam.c -- Hard coded result to simulatorVersion query
This is actually a test file list that is specific to a major version.
The regression test scripts query the version of the compiler to infer
that it must include this list of tests. For example, for version 12.x
of the compiler, the needs to be an ivltest/regress-v12.list file that
lists the tests that are specific to that version.
* ivltests/regress-XXX.list -- Version specific regression tests