aboutsummaryrefslogtreecommitdiffstats
path: root/doc/using/Synthesis.rst
diff options
context:
space:
mode:
authorumarcor <unai.martinezcorral@ehu.eus>2021-04-22 16:39:56 +0200
committertgingold <tgingold@users.noreply.github.com>2021-04-22 18:53:03 +0200
commite6f2e299607dd76fd0c9f1129a138a0517e7646c (patch)
tree1be6dfd14c9480d65e242e30d0582404c3c6be49 /doc/using/Synthesis.rst
parent8444c4d233aade37c218ef778bd1105dca693f48 (diff)
downloadghdl-e6f2e299607dd76fd0c9f1129a138a0517e7646c.tar.gz
ghdl-e6f2e299607dd76fd0c9f1129a138a0517e7646c.tar.bz2
ghdl-e6f2e299607dd76fd0c9f1129a138a0517e7646c.zip
doc: style, use '[options...]' consistently
Diffstat (limited to 'doc/using/Synthesis.rst')
-rw-r--r--doc/using/Synthesis.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/using/Synthesis.rst b/doc/using/Synthesis.rst
index c1a954e31..575da022b 100644
--- a/doc/using/Synthesis.rst
+++ b/doc/using/Synthesis.rst
@@ -30,14 +30,14 @@ versions of the standard, but which don't provide the most recent features.
Currently, the default output is a generic netlist using a (very simple) subset of VHDL 1993.
See :option:`--out` and :ghdlsharp:`1174` for on-going discussion about other output formats.
-.. option:: --synth <[options] [library.]top_unit [arch]>
+.. option:: --synth <[options...] [library.]top_unit [arch]>
Elaborates for synthesis the design whose top unit is indicated by ``[library.]top_unit [arch]``.
.. ATTENTION::
All the units must have been analyzed; that is, the artifacts of previously executed :option:`-a` calls must exist.
-.. option:: --synth <[options] files... -e [top_unit [arch]]>
+.. option:: --synth <[options...] files... -e [top_unit [arch]]>
Analyses and elaborates for synthesis the files present on the command line only.
Elaboration starts from the top unit indicated by ``[top_unit [arch]]``.
@@ -45,7 +45,7 @@ See :option:`--out` and :ghdlsharp:`1174` for on-going discussion about other ou
.. IMPORTANT::
Files can be provided in any order, but ``-e`` must be provided after them.
- That is, ``--synth <[options] files...>`` is NOT supported.
+ That is, ``--synth <[options...] files...>`` is NOT supported.
This is because we want to unambiguously tell files and the unit specification apart.
We don't want to rely on parsing the items and guessing whether we are dealing with files or a top unit name.
In corner cases, a filename might exist which matches the name of a primary unit: ``ghdl synth name``.