Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: clarify that GHDL is a rolling project #694

Merged
merged 2 commits into from
Nov 17, 2020
Merged

docs: clarify that GHDL is a rolling project #694

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
90a102f
Added a note to clarify that GHDL version
DeniTCH Nov 15, 2020
254df5e
Changed the GHDL note URL to inline.
DeniTCH Nov 16, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/installing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Simulators:
- `Aldec Active-HDL`_: Tested with Active-HDL 9.3, 10.1, 10.2, 10.3 (x64/x86)
- `GHDL`_

- Works with versions >= 0.33
- Works with versions >= 0.33 (Note: GHDL is a rolling project, it is therefore recommended to use the latest `nightly release`_ tarball.)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please, write the URL inline:

`nightly release <https://github.com/ghdl/ghdl/releases/tag/nightly>`_

Also, you can write the Note as an admonition:

      -  Works with versions >= 0.33
         .. NOTE:: GHDL is a rolling project, it is therefore recommended to use the latest `nightly release <https://github.com/ghdl/ghdl/releases/tag/nightly>`_ tarball.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inlined the URL, as you suggested.

- Tested with LLVM and mcode backends, gcc backend might work aswell.
- Integrated support for using `GTKWave`_ to view waveforms.

Expand All @@ -42,8 +42,10 @@ Simulators:
.. _Mentor Graphics ModelSim/Questa: http://www.mentor.com/products/fv/modelsim/
.. _Cadence Incisive: https://www.cadence.com/content/cadence-www/global/en_US/home/tools/system-design-and-verification/simulation-and-testbench-verification/incisive-enterprise-simulator.html
.. _GHDL: https://github.com/ghdl/ghdl
.. _nightly release: https://github.com/ghdl/ghdl/releases/tag/nightly
.. _GTKWave: http://gtkwave.sourceforge.net/


.. _installing_pypi:

Using the Python Package Manager
Expand Down