luke
/
iverilog
mirror of https://github.com/steveicarus/iverilog.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
iverilog/Documentation/developer/version_stamps.rst

33 lines
1.3 KiB
ReStructuredText
Raw Normal View History

Start Icarus Verilog Documentation using Sphinx Embed the Icarus Verilog documentation, and format it so that the Sphinx tools can process it into html or other formats. This will make the documentation easier to keep up to date with the actual software.
2022-04-11 03:19:30 +02:00
Files With Version Information
Fix sphinx warnings.
2022-04-12 05:04:00 +02:00
==============================
Start Icarus Verilog Documentation using Sphinx Embed the Icarus Verilog documentation, and format it so that the Sphinx tools can process it into html or other formats. This will make the documentation easier to keep up to date with the actual software.
2022-04-11 03:19:30 +02:00
These are the only files that have version information in them:
* version_base.h -- This should be the 1 source for version info.
* version_tag.h -- Generated automatically with git tag information.
* verilog.spec -- Used to stamp RPM packages
When versions are changed, the above files need to be edited to account for
typo fixes
2024-10-08 06:20:12 +02:00
the new version information. The following used to have version information in
Start Icarus Verilog Documentation using Sphinx Embed the Icarus Verilog documentation, and format it so that the Sphinx tools can process it into html or other formats. This will make the documentation easier to keep up to date with the actual software.
2022-04-11 03:19:30 +02:00
them, but now their version information is generated:
ivtest: Document the ivest/regress-vNN.list file. This is another bit that needs to be accounted for when changing versions.
2022-12-27 01:33:26 +01:00
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.
Start Icarus Verilog Documentation using Sphinx Embed the Icarus Verilog documentation, and format it so that the Sphinx tools can process it into html or other formats. This will make the documentation easier to keep up to date with the actual software.
2022-04-11 03:19:30 +02:00
Update the development documentation to match reality
2026-02-28 16:03:14 +01:00
The files below are now edited by the Makefile and the version.exe program:
Start Icarus Verilog Documentation using Sphinx Embed the Icarus Verilog documentation, and format it so that the Sphinx tools can process it into html or other formats. This will make the documentation easier to keep up to date with the actual software.
2022-04-11 03:19:30 +02:00
* 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
ivtest: Document the ivest/regress-vNN.list file. This is another bit that needs to be accounted for when changing versions.
2022-12-27 01:33:26 +01:00
This now includes version_base.h to get the version:
Start Icarus Verilog Documentation using Sphinx Embed the Icarus Verilog documentation, and format it so that the Sphinx tools can process it into html or other formats. This will make the documentation easier to keep up to date with the actual software.
2022-04-11 03:19:30 +02:00
* vpi/vams_simparam.c -- Hard coded result to simulatorVersion query
ivtest: Document the ivest/regress-vNN.list file. This is another bit that needs to be accounted for when changing versions.
2022-12-27 01:33:26 +01:00
Update the development documentation to match reality
2026-02-28 16:03:14 +01:00
The test suite no longer has version specific files since it tracks along with
the code/branch.