aboutsummaryrefslogtreecommitdiffstats
path: root/doc/quick_start/simulation/hello
diff options
context:
space:
mode:
authorumarcor <unai.martinezcorral@ehu.eus>2022-02-07 19:28:23 +0100
committerumarcor <unai.martinezcorral@ehu.eus>2022-02-07 19:41:40 +0100
commit6a694dd839a18cdf0382753fffc17aa1fbd41f9d (patch)
treee7330a6cd6d87f80d63cc846100175b4817682bf /doc/quick_start/simulation/hello
parentea18eb25e53567a979d40d6cc2d69e1d3e289c93 (diff)
downloadghdl-6a694dd839a18cdf0382753fffc17aa1fbd41f9d.tar.gz
ghdl-6a694dd839a18cdf0382753fffc17aa1fbd41f9d.tar.bz2
ghdl-6a694dd839a18cdf0382753fffc17aa1fbd41f9d.zip
doc: use extlinks more
Diffstat (limited to 'doc/quick_start/simulation/hello')
-rw-r--r--doc/quick_start/simulation/hello/index.rst48
1 files changed, 26 insertions, 22 deletions
diff --git a/doc/quick_start/simulation/hello/index.rst b/doc/quick_start/simulation/hello/index.rst
index 104a12efa..005706df8 100644
--- a/doc/quick_start/simulation/hello/index.rst
+++ b/doc/quick_start/simulation/hello/index.rst
@@ -14,23 +14,26 @@ a file named :file:`hello.vhdl`:
* Both ``.vhdl`` and ``.vhd`` extensions are used for `VHDL` source files, while ``.v`` is used for Verilog.
- * Since, extension ``.vhd`` is also interpreted as a `Virtual Hard Disk <https://en.wikipedia.org/wiki/VHD_(file_format)>`_
- file format, some users prefer ``.vhdl``, to avoid ambiguity. This is the case with `GHDL`'s codebase. However, in order
- to maintain `backward-compatibility <https://en.wikipedia.org/wiki/8.3_filename>`_ with legacy DOS systems,
- other users prefer ``.vhd``.
-
- * Unless you use especial characters, either `UTF-8` or `ISO-8859-1` encodings can be used. However, if you do, the
- latter should be used. The standard defines ASCII (7-bit encoding) or ISO Latin-1 (ISO-8859-1) as default.
+ * Since, extension ``.vhd`` is also interpreted as a :wikipedia:`Virtual Hard Disk <VHD_(file_format)>` file
+ format, some users prefer ``.vhdl``, to avoid ambiguity.
+ This is the case with `GHDL`'s codebase.
+ However, in order to maintain :wikipedia:`backward-compatibility <https://en.wikipedia.org/wiki/8.3_filename>`
+ with legacy DOS systems, other users prefer ``.vhd``.
+
+ * Unless you use especial characters, either `UTF-8` or `ISO-8859-1` encodings can be used.
+ However, if you do, the latter should be used.
+ The standard defines ASCII (7-bit encoding) or ISO Latin-1 (ISO-8859-1) as default.
However, GHDL has a relaxing option, :option:`--mb-comments` (multi byte), to allow UTF-8 or other encodings in
comments.
-- First, you have to compile the file; this is called :ref:`analysis <Analysis:command>` of a design file in `VHDL`
- terms. Run ``ghdl -a hello.vhdl`` in the `shell`. This command creates or updates a file :file:`work-obj93.cf`, which
- describes the library ``work``.
-- Then, run ``ghdl -e hello_world`` in the `shell`. Command :option:`-e` means :ref:`elaborate <Elaboration:command>`,
- which is used to build a design, with the ``hello_world`` entity at the top of the hierarchy.
-- Last, you can directly launch the simulation :ref:`running <Run:command>` ``ghdl -r hello_world`` in the `shell`. The
- result of the simulation will be shown on screen:
+* First, you have to compile the file; this is called :ref:`analysis <Analysis:command>` of a design file in `VHDL`
+ terms. Run ``ghdl -a hello.vhdl`` in the `shell`.
+ This command creates or updates a file :file:`work-obj93.cf`, which describes the library ``work``.
+* Then, run ``ghdl -e hello_world`` in the `shell`.
+ Command :option:`-e` means :ref:`elaborate <Elaboration:command>`, which is used to build a design, with the
+ ``hello_world`` entity at the top of the hierarchy.
+* Last, you can directly launch the simulation :ref:`running <Run:command>` ``ghdl -r hello_world`` in the `shell`.
+ The result of the simulation will be shown on screen:
.. code-block:: shell
@@ -40,14 +43,15 @@ a file named :file:`hello.vhdl`:
If a GCC/LLVM variant of `GHDL` is used:
* :ref:`Analysis <Analysis:command>` generates a file, :file:`hello.o`, which is the object file corresponding to
- your `VHDL` program. This is not created with :ref:`mcode <BUILD>`. These kind of object files can be
- compiled into foreign programs (see :ref:`Linking_with_Ada`).
+ your `VHDL` program. This is not created with :ref:`mcode <BUILD>`.
+ These kind of object files can be compiled into foreign programs (see :ref:`Linking_with_Ada`).
* The :ref:`elaboration <Elaboration:command>` step is mandatory after running the analysis and prior to launching the
- simulation. This will generate an executable binary named :file:`hello_world`.
- * As a result, :option:`-r` is just a passthrough to the binary generated in the `elaboration`. Therefore, the
- executable can be run directly: ``./hello_world``. See :option:`-r` for more informartion.
+ simulation.
+ This will generate an executable binary named :file:`hello_world`.
+ * As a result, :option:`-r` is just a passthrough to the binary generated in the `elaboration`.
+ Therefore, the executable can be run directly: ``./hello_world``. See :option:`-r` for more informartion.
.. HINT::
-
- :option:`-e` can be bypassed with :ref:`mcode <BUILD>`, since :option:`-r` actually elaborates the design and saves
- it on memory before running the simulation. But you can still use it to check for some elaboration problems.
+ :option:`-e` can be bypassed with :ref:`mcode <BUILD>`, since :option:`-r` actually elaborates the design and saves
+ it on memory before running the simulation.
+ But you can still use it to check for some elaboration problems.