1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
|
*********************
Flaws and bugs report
*********************
Despite all the testing and already reported issues, you can find bugs
or propose enhancements.
.. _reporting_bugs:
Reporting bugs
==============
In order to improve GHDL, we welcome bugs report and suggestions for
any aspect of GHDL. Please create an issue on
https://github.com/tgingold/ghdl/issues
If the compiler crashes, this is a bug. Reliable tools never crash.
If your compiled VHDL executable crashes, this may be a bug at
runtime or the code produced may be wrong. However, since VHDL
has a notion of pointers, an erroneous VHDL program (using invalid
pointers for example) may crash.
If the compiler emits an error message for a perfectly valid input or
does not emit an error message for an invalid input, this may be a bug.
Please send the input file and what you expected. If you know the LRM
well enough, please specify the paragraph which has not been well
implemented. If you don't know the LRM, maybe your bug report will be
rejected simply because there is no bug. In the latter case, it may be
difficult to discuss the issue; and comparisons with other VHDL tools
is not a very strong argument.
If a compiler message is not clear enough for you, please tell me. The
error messages can be improved, but I have not enough experience with
them.
If you have found a mistake in the manual, please send a comment. If
you have not understood some parts of this manual, please tell me.
English is not my mother tongue, so this manual may not be well-written.
Again, rewriting part of it is a good way to improve it.
If you send a `VHDL` file producing a bug, it is a good idea to try
to make it as short as possible. It is also a good idea to make it
looking like a test: write a comment which explains whether the file
should compile, and if yes, whether or not it should run successfully.
In the latter case, an assert statement should finish the test; the
severity level note indicates success, while a severity level failure
indicates failure.
For bug reports, please include enough information for the maintainers to
reproduce the problem. This includes:
* the version of `GHDL` (you can get it with :samp:`ghdl --version`).
* the operating system
* whether you have built `GHDL` from sources or used the binary
distribution.
* the content of the input files
* a description of the problem and samples of any erroneous input
* anything else that you think would be helpful.
Future improvements
===================
I have several axes for `GHDL` improvements:
* Documentation.
* Better diagnostics messages (warning and error).
* Full support of VHDL-2008.
* Optimization (simulation speed).
* Graphical tools (to see waves and to debug)
* Style checks
* VITAL acceleration
|
