diff options
| author | umarcor <38422348+umarcor@users.noreply.github.com> | 2020-04-10 07:48:47 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-04-10 07:48:47 +0200 |
| commit | 2bea592952b8a9f9860bb646ddf72d26eac4ad29 (patch) | |
| tree | 52f50b443a2d15a3f49d8cee8cd77538a9fa1292 /doc/contribute.rst | |
| parent | 713cd87326302ee2ad750ec6d9d3a601f315e66b (diff) | |
| download | ghdl-2bea592952b8a9f9860bb646ddf72d26eac4ad29.tar.gz ghdl-2bea592952b8a9f9860bb646ddf72d26eac4ad29.tar.bz2 ghdl-2bea592952b8a9f9860bb646ddf72d26eac4ad29.zip | |
update doc (synth, overview, generics, etc.) (#1205)
* doc: extend info about setting generics through the CLI
* doc: rename 'Command Reference' to 'Additional Command Reference'
* doc: use '``' instead of ':samp:'
* doc: update info about synthesis
* doc: add references to sources in internals/Overview
* doc: add diagram to internals/Overview
Diffstat (limited to 'doc/contribute.rst')
| -rw-r--r-- | doc/contribute.rst | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/doc/contribute.rst b/doc/contribute.rst index 8b7710190..aeb2b4290 100644 --- a/doc/contribute.rst +++ b/doc/contribute.rst @@ -1,3 +1,5 @@ +.. program:: ghdl + .. only:: html .. exec:: @@ -38,9 +40,12 @@ Reporting bugs .. TIP:: * If the compiler crashes, this is a bug. Reliable tools never 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. - * If the executable created from your VHDL sources crashes, this may be a bug at runtime or the code itself may be wrong. However, since VHDL has a notion of pointers, an erroneous VHDL program (using invalid pointers for example) may crash. + * If the executable created from your VHDL sources crashes, this may be a bug at runtime or the code itself may be wrong. Since VHDL has a notion of pointers, an erroneous VHDL program (using invalid pointers for example) may crash. * If a compiler message is not clear enough, please tell us. The error messages can be improved, but we do not have enough experience with them. +.. TIP:: + It is suggested to test synthesis features with :option:`--synth`, before processing the design with :ref:`Synth:plugin`. + Please, report issues of this kind through |SHIELD:bug-report|, as this allows us to categorize issues into groups and to assign developers to them. You can track the issue’s state and see how it’s getting solved. @@ -63,7 +68,7 @@ to assign developers to them. You can track the issue’s state and see how it†* Anything else that you think would be helpful. .. NOTE:: - If you don't know the LRM, be aware that an issue claimed as a bug report may be rejected because there is no bug according to it. GHDL aims at implementing VHDL as defined in `IEEE 1076 <http://ieeexplore.ieee.org/document/4772740/>`_. However, some other tools allow constructs which do not fully follow the standard revisions. Therefore, comparisons with other VHDL is not a solid argument. Some of them are supported by GHDL (see :ref:`IEEE_library_pitfalls`), but any such enhancement will have very low priority. + If you don't know the LRM, be aware that an issue claimed as a bug report may be rejected because there is no bug according to it. GHDL aims at implementing VHDL as defined in `IEEE 1076 <http://ieeexplore.ieee.org/document/4772740/>`_. However, some other tools allow constructs which do not fully follow the standard revisions. Therefore, comparisons with other VHDL variants is not a solid argument. Some of them are supported by GHDL (see :ref:`IEEE_library_pitfalls`), but any such enhancement will have very low priority. .. _requesting_enhancements: |