dad78d5258
Move details of non-standard behaviour from README to Documentation.
...
Some of this was duplicated in the documentation, some of it was only
in the README. Let's have it all in one place, linked to from the
README.
2025-08-03 18:19:45 +01:00
1be953cfa6
Move documentation of additional system tasks from quirks to extensions.
2025-08-03 17:38:24 +01:00
fa5fc0eca0
Copy portability notes from old Wiki to new documentation area.
...
From https://iverilog.fandom.com/wiki/Verilog_Portability_Notes
Also add formatting tags to $readmempath documentation to make style
consistent.
2025-08-03 17:32:55 +01:00
6088a26d78
Update VPI example to not have warnings
2025-02-13 01:04:41 -08:00
ee021dbce4
Fix whitespace in vvp flags on-line documentation.
2024-12-31 18:08:36 +00:00
05d4e3fc73
Add reminder about vvp extended argument usage to on-line documention.
...
Although the introductory paragraph seems clear enough, add a reminder
at the start of the section on extended arguments that they must appear
after the input file name.
2024-12-31 15:28:55 +00:00
88aae83bec
Add missing vvp flags in the on-line documentation.
...
The -i, -n. -N, and -V flags were documented in the man page, but not
in vvp_flags.rst.
2024-12-31 15:22:28 +00:00
a3903c6cd3
Document the new vvp quiet flag.
2024-12-31 15:16:09 +00:00
01d28ea277
typo fixes
2024-10-07 23:20:12 -05:00
61943c844d
Merge pull request #1068 from gatk555/libvvp
...
Configure option --enable-libvvp allows vvp to be used a shared library
2024-02-18 11:33:44 -08:00
79c644f550
Update and correct documentation of extended data types (xtypes).
2024-01-28 18:23:29 +00:00
9cccd35e59
Move Icarus Verilog extensions documentation to the usage section.
...
Also fix the text in the usage section index.
2024-01-28 17:44:23 +00:00
95810b2f61
Configure with --enable-libvvp builds a shared library containing
...
almost all of vvp that may be used by other programs.
The vvp program becomes a small client of libvvp.
2024-01-24 11:46:02 +00:00
71b9c551df
Move tests pr2509349a/b to the new test format.
...
This removes the regress-msys2.list file, fixes the output from the
pr2509349a.v test to not be different on different systems, and
documents the $readmempath task.
2024-01-21 15:49:09 -08:00
38058400f7
Update docs Copyright
2024-01-20 18:10:30 -08:00
56c5bf1da1
ivtest: Remove regress v11, v12, and v13
...
These tests lists are no longer needed.
2023-12-17 20:13:00 -08:00
1cc6fe835b
Update ufunc/e documentation
2023-09-03 18:45:54 -07:00
eb104a727e
initial commit
2023-07-28 22:22:15 -07:00
6307057e8d
Fix space issues
2023-06-10 19:44:10 -07:00
f4345e2d03
Add favicon
2023-06-09 14:07:28 +02:00
b0c1eab51e
Move textfiles to documentation
2023-06-09 13:30:44 +02:00
265f585096
Document all targets
2023-06-09 13:28:14 +02:00
ef931e2e0d
Spelling and space cleanup
2023-05-31 22:44:13 -07:00
deeac2edfe
Fix broken example code (discussion #922 )
...
'output' is a keyword, so can't be used as a signal name.
2023-05-15 19:42:47 +01:00
564304d20c
ivtests: Add support for vlog95 tests
...
This adds the "normal-vlog95" test type, because we need to run a different
set of commands for this to work so a new test type makes sense. This also
moves a few of the existing tests to the new format in order to test the
new test rig.
2023-03-05 15:09:04 -08:00
50722494b9
ivtest: Add the dumpfile.v test
...
Add a regression test to show that the proper dumpfile is selected, by
noting in the output from the vvp command what file name it is creating.
To make this work, I also needed to add some capabilities to the vvp_reg.py
regression test rig.
2023-02-26 14:43:01 -08:00
29ac33493e
Add support for a command line dumpfile option
...
The -dumpfile=<path> vvp extended argument sets the default nanme to use
for the various dumpers. If this flag is not given, the default is "dump".
The $dumpfile system task overrides the default or this command line flag.
This commit also factors out all the dumpfile selection code for the various
dumper implementations.
2023-02-26 14:05:42 -08:00
3085bd6845
ivtest: Move some tests to the revress-vvp list
...
Move some tests from the old structure to the new more descriptive
test suite. Remove them from the old lists.
2023-02-11 18:35:41 -08:00
4ea442b2d9
ivtest: Create the vvp_reg.py test script
...
This creates a new test suite driver and infrastructure for going
forward. This cleans up the descriptions for tests, and is more
extensible.
Include documentation for the new engine, so that new tests can go
here instead of the old test suite.
2023-02-11 18:33:24 -08:00
a7c5eceeea
ivtest: Document the ivest/regress-vNN.list file.
...
This is another bit that needs to be accounted for when changing versions.
2022-12-26 20:10:56 -05:00
06c819849f
vvp: Document the vvp interactive debug mode
...
Vvp has an interactive debug mode that few seem to be aware of. Document
that mode.
2022-12-11 12:12:24 -08:00
5a90b7857a
Add -R option to print runtime paths (for now, includedir only)
...
This allows for, e.g., a Makefile to find the location of vpi_user.h in a portable manner. Similar to pkgconfig.
2022-07-02 18:05:26 -07:00
bd94c72472
Document using gtkwave with Icarus Verilog
...
Recover the Icarus Verilog documentation for using GTKWave. It needs a bit
of rework, and formatting.
2022-04-18 20:01:59 -07:00
3166973f59
Document getting started as a developer
2022-04-16 07:58:14 -07:00
0dc8596a89
Action to deploy documentation to gh-pages
2022-04-15 20:49:13 -07:00
083671cc4b
Merge pull request #683 from je-miralles/em_docs_verilog_formatting
...
Fix verilog formatting in usage docs code-blocks
2022-04-13 12:42:32 -07:00
48f486ef83
Fix verilog formatting in usage docs code-blocks
2022-04-13 16:16:32 +02:00
a4a60ec07b
Escape special chars for sphinx markup warnings
2022-04-13 12:31:30 +02:00
2781aa05e1
Documentation: Transferring more content from the wiki
...
This finishes up most of the User Guide from the Wiki. Some bits
from the wiki are just too aweful, or obsolete, so are left out.
2022-04-12 17:26:53 -07:00
f3c4967085
Fix sphinx warnings.
2022-04-11 20:04:00 -07:00
2f091c8f45
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-10 19:24:08 -07:00
Martin Whitaker
Cary R
henry
ga
Stephen Williams
Ethan Sifferman
mole99
Stephen Williams
Jevin Sweval
Emilio Miralles