aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorumarcor <unai.martinezcorral@ehu.eus>2021-04-22 18:05:37 +0200
committertgingold <tgingold@users.noreply.github.com>2021-04-22 18:53:03 +0200
commit792f4dbc5b7e692a9862cdfcc4b0243016e5be1c (patch)
treef0bcc567414a5cf0dc1987131d4493e952ba4c0f
parent50cde8587d02b60e48a7cc538eaa412357a78be3 (diff)
downloadghdl-792f4dbc5b7e692a9862cdfcc4b0243016e5be1c.tar.gz
ghdl-792f4dbc5b7e692a9862cdfcc4b0243016e5be1c.tar.bz2
ghdl-792f4dbc5b7e692a9862cdfcc4b0243016e5be1c.zip
doc/using: document command 'elab-order' (79fc4b05)
-rw-r--r--doc/using/InvokingGHDL.rst18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/using/InvokingGHDL.rst b/doc/using/InvokingGHDL.rst
index 3a06338eb..f7ea85418 100644
--- a/doc/using/InvokingGHDL.rst
+++ b/doc/using/InvokingGHDL.rst
@@ -222,6 +222,24 @@ The make command will then be able to recursively build a hierarchy from an enti
However, since they are not analyzed, many errors are tolerated by this command.
See :option:`-m`, to actually build the design.
+See also :option:`--elab-order`, for retrieving the compilation order guessed recursively.
+
+
+.. index:: cmd elaboration order
+
+Elab-order [``--elab-order``]
+-----------------------------
+
+.. option:: --elab-order <[options...] [libray.]top_unit [arch]>
+
+Print the list of sources required for elaborating a unit, in order for them to be analyzed without dependency issues.
+This is expected to be used after :option:`-i`, or for retrieving the order for some unit analyzed through third-party
+scripts.
+
+.. ATTENTION::
+ Currently, the list does not include information about the logical library names where each source needs to be
+ analyzed.
+ Hence, it is mostly useful when all sources belong to the same ``WORK`` library.
.. index:: cmd make