Skip to content

Commit

Permalink
Minor doc impr from umarcor/pull/1
Browse files Browse the repository at this point in the history
  • Loading branch information
RocketRoss committed Apr 13, 2020
1 parent 93d01c6 commit 941c029
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 6 deletions.
10 changes: 5 additions & 5 deletions doc/examples/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
Examples
########

This sections contains advanced examples using specific features of the language, the tool,
or interaction with third-party projects. It is suggested for users who are new to either
`GHDL` or `VHDL` to read :ref:`USING:QuickStart` first.
It is suggested that users who are new to either `GHDL` or `VHDL` read, and execute, the examples in :ref:`USING:QuickStart` first.

.. toctree::
The following sections contain advanced examples using specific features of the language, the tool,
or interaction with third-party projects.

../examples/VHPIDIRECT
- `ghld-cosim <https://github.com/ghdl/ghdl-cosim>`_ is centered around accessing the GHDL simulation, or data used in the simulation, from another program and vice-versa.
- ... More to be made
2 changes: 1 addition & 1 deletion doc/examples/quick_start/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The following tips might be useful:

* Use :option:`--ieee=synopsys <--ieee>` if your design depends on a non-standard implementation of the IEEE library.

* Use :option:`-fexplicit` and :option:`-frelaxed-rules` if needed.
* Use :option:`-fexplicit` and :option:`-frelaxed-rules` if needed. For instance when relaxing VHDL 2008's need for shared variables to be protected types, you can use `--std=08 -frelaxed`.

* Use :option:`--work=LIB_NAME <--work>` to analyze files into the ``LIB_NAME`` library.
To use files analyzed to a different directory, give the path
Expand Down
1 change: 1 addition & 0 deletions doc/using/Foreign.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ You can define a subprogram in a foreign language (such as `C` or
.. ATTENTION::
As a consequence of the runtime copyright, you are not allowed to distribute an executable produced by GHDL without allowing access to the VHDL sources. See :ref:`INTRO:Copyrights`.

.. _foreign_declarations:

Foreign declarations
====================
Expand Down

0 comments on commit 941c029

Please sign in to comment.