aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorCiro Santilli 六四事件 法轮功 包卓轩 <ciro.santilli@gmail.com>2016-06-16 18:46:08 +0200
committertgingold <tgingold@users.noreply.github.com>2016-06-16 18:46:08 +0200
commitdad5c0002640fec80cc37e397e06e9526784478b (patch)
tree81dbc9d5a8049216401ab81e841902f15ae2863f /doc
parent79854e18349bb32c1fcda32614bea77aa92857cc (diff)
downloadghdl-dad5c0002640fec80cc37e397e06e9526784478b.tar.gz
ghdl-dad5c0002640fec80cc37e397e06e9526784478b.tar.bz2
ghdl-dad5c0002640fec80cc37e397e06e9526784478b.zip
Document GCC backend needed to generate executables (#80)
Diffstat (limited to 'doc')
-rw-r--r--doc/Invoking_GHDL.rst9
-rw-r--r--doc/Starting_with_GHDL.rst7
2 files changed, 9 insertions, 7 deletions
diff --git a/doc/Invoking_GHDL.rst b/doc/Invoking_GHDL.rst
index b0410f207..0b845b481 100644
--- a/doc/Invoking_GHDL.rst
+++ b/doc/Invoking_GHDL.rst
@@ -55,10 +55,11 @@ Elaborate a design::
ghdl -e [options..] primary_unit [secondary_unit]
-On GNU/Linux the elaboration command creates an executable
-containing the code of the `VHDL` sources, the elaboration code
-and simulation code to execute a design hierarchy. On Windows this
-command elaborates the design but does not generate anything.
+On GNU/Linux, if the GCC backend was enabled during the compilation of `GHDL`,
+the elaboration command creates an executable containing the code of the `VHDL`
+sources, the elaboration code and simulation code to execute a design hierarchy.
+On Windows or if the GCC backend was not enabled, this command elaborates the design
+but does not generate anything.
The elaboration command is selected with :option:`-e` switch, and must be
followed by either:
diff --git a/doc/Starting_with_GHDL.rst b/doc/Starting_with_GHDL.rst
index bba4b7b7a..c7cd00f96 100644
--- a/doc/Starting_with_GHDL.rst
+++ b/doc/Starting_with_GHDL.rst
@@ -54,8 +54,8 @@ The :option:`-e` option means :dfn:`elaborate`. With this option, `GHDL`
creates code in order to elaborate a design, with the :samp:`hello_world`
entity at the top of the hierarchy.
-On GNU/Linux, the result is an executable program called :file:`hello_world`
-which can be run:
+On GNU/Linux, if you have enabled the GCC backend during the compilation of `GHDL`,
+an executable program called :file:`hello_world` which can be run is generated:
.. code-block:: shell
@@ -68,7 +68,8 @@ or directly:
$ ./hello_world
-On Windows, no file is created. The simulation is launched using this command:
+On Windows or if the GCC backend was not enabled, no file is created.
+The simulation is launched using this command:
.. code-block:: shell