From a7c5eceeeaf3aad4b51e3e75b0c62a13d1e16d0b Mon Sep 17 00:00:00 2001 From: Stephen Williams Date: Mon, 26 Dec 2022 19:33:26 -0500 Subject: [PATCH] ivtest: Document the ivest/regress-vNN.list file. This is another bit that needs to be accounted for when changing versions. --- Documentation/developer/version_stamps.rst | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/Documentation/developer/version_stamps.rst b/Documentation/developer/version_stamps.rst index 384c58d2a..c748113f7 100644 --- a/Documentation/developer/version_stamps.rst +++ b/Documentation/developer/version_stamps.rst @@ -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 them, but now their version information is generated: -Replaced with version_base.h, which is edited manually, and -version_tag.h which is generated from git tag information. +The version_tag.h file is generated from git tag information using +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 - -These are now edited by the makefile and the version.exe program. +The files below are now edited by the makefile and the version.exe program: * iverilog-vpi.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 * 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 + +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