aboutsummaryrefslogtreecommitdiffstats
path: root/doc/references
diff options
context:
space:
mode:
authorArcturus <44707562+arcturus140@users.noreply.github.com>2019-09-18 17:43:49 +0100
committertgingold <tgingold@users.noreply.github.com>2019-09-18 18:43:49 +0200
commit4e000b8157514d78b9c91dde69ec218f6dcb4d2a (patch)
treefc68be3b423d441602708e44345d7d4c951e7c61 /doc/references
parenteb3d32a6de8822eb87a6bfd72dc1c94f9ff9a107 (diff)
downloadghdl-4e000b8157514d78b9c91dde69ec218f6dcb4d2a.tar.gz
ghdl-4e000b8157514d78b9c91dde69ec218f6dcb4d2a.tar.bz2
ghdl-4e000b8157514d78b9c91dde69ec218f6dcb4d2a.zip
enhance documentation terminology: reduce name clashing for VHDL standard and collections. (#925)
* enhance documentation terminology: reduce name clashing for VHDL standard and collections. * lists don't have columns * apply suggestions from review * remove build artifact
Diffstat (limited to 'doc/references')
-rw-r--r--doc/references/ImplementationOfVHDL.rst29
1 files changed, 21 insertions, 8 deletions
diff --git a/doc/references/ImplementationOfVHDL.rst b/doc/references/ImplementationOfVHDL.rst
index 55f4f5141..550725f99 100644
--- a/doc/references/ImplementationOfVHDL.rst
+++ b/doc/references/ImplementationOfVHDL.rst
@@ -72,8 +72,7 @@ The latest version is 2008. Many features have been added, and GHDL
doesn't implement all of them.
You can select the VHDL standard expected by GHDL with the
-``--std=VER`` option, where ``VER`` is one of the left column of the
-table below:
+``--std=<STANDARD>`` option, where ``<STANDARD>`` is one of the list below:
87
@@ -101,9 +100,21 @@ table below:
08
Select VHDL-2008 standard (partially implemented).
-The 93, 93c, 00 and 02 standards are considered compatible: you can
-elaborate a design mixing these standards. However, 87, 93 and 08 are
-not compatible.
+Multiple standards can be used in a design:
+
++-----+----------------+
+|GROUP| VHDL Standard |
++=====+================+
+| 87 | 87 |
++-----+----------------+
+| 93 | 93, 93c, 00, 02|
++-----+----------------+
+| 08 | 08 |
++-----+----------------+
+
+.. note::
+
+ The standards in each group are considered compatible: you can elaborate a design mixing these standards. However, standards of different groups are not compatible.
.. _psl_implementation:
@@ -177,13 +188,15 @@ Library database
Each design unit analyzed is placed into a design library. By default,
the name of this design library is ``work``; however, this can be
-changed with the :option:`--work=NAME` option of GHDL.
+changed with the :option:`--work=<LIB_NAME>` option of GHDL.
To keep the list of design units in a design library, GHDL creates
-library files. The name of these files is :file:`NAME-objVER.cf`, where
-`NAME` is the name of the library, and `VER` the VHDL version (87,
+library files. The name of these files is :file:`<LIB_NAME>-obj<GROUP>.cf`, where
+`<LIB_NAME>` is the name of the library, and `<GROUP>` the VHDL version (87,
93 or 08) used to analyze the design units.
+For details on ``GROUP`` values see section :ref:`VHDL_standards`.
+
You don't have to know how to read a library file. You can display it
using the *-d* of `ghdl`. The file contains the name of the
design units, as well as the location and the dependencies.