aboutsummaryrefslogtreecommitdiffstats
path: root/doc/using
diff options
context:
space:
mode:
authorTristan Gingold <tgingold@free.fr>2021-10-04 04:42:33 +0200
committerTristan Gingold <tgingold@free.fr>2021-10-04 04:42:33 +0200
commitaf7c36fb9d32653e08fc99550b5eddce080202a7 (patch)
treeae0b4f946412d7edb869d547bd5e5287ba2d806e /doc/using
parentbd7df2697ac927ff200c1d3af4035cb8572d0dcf (diff)
downloadghdl-af7c36fb9d32653e08fc99550b5eddce080202a7.tar.gz
ghdl-af7c36fb9d32653e08fc99550b5eddce080202a7.tar.bz2
ghdl-af7c36fb9d32653e08fc99550b5eddce080202a7.zip
elab-order command: add an option to display libraries. Fix #1736
Diffstat (limited to 'doc/using')
-rw-r--r--doc/using/InvokingGHDL.rst20
1 files changed, 12 insertions, 8 deletions
diff --git a/doc/using/InvokingGHDL.rst b/doc/using/InvokingGHDL.rst
index f7ea85418..b50f98626 100644
--- a/doc/using/InvokingGHDL.rst
+++ b/doc/using/InvokingGHDL.rst
@@ -232,14 +232,18 @@ 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.
+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.
+
+With the :option:`--libraries` option, each line contains first the
+library name followed by the file name.
+
+Without the :option:`--libraries` option, the list does not include
+information about the logical library names where each source needs
+to be analyzed. Hence, it is useful when all sources belong
+to the same ``WORK`` library.
.. index:: cmd make