aboutsummaryrefslogtreecommitdiffstats
path: root/doc/building/llvm/GNULinux-GNAT.rst
diff options
context:
space:
mode:
author1138-4EB <1138-4EB@users.noreply.github.com>2017-12-14 09:05:01 +0100
committertgingold <tgingold@users.noreply.github.com>2017-12-15 06:13:28 +0100
commite89bb574675e6225110a654f712b8ea916609cc2 (patch)
treedb954a09e6e64492b05e36df1115fc58c88d8133 /doc/building/llvm/GNULinux-GNAT.rst
parenta0ea3c04c7fdb1795ee8c5bd235cb838bb68af98 (diff)
downloadghdl-e89bb574675e6225110a654f712b8ea916609cc2.tar.gz
ghdl-e89bb574675e6225110a654f712b8ea916609cc2.tar.bz2
ghdl-e89bb574675e6225110a654f712b8ea916609cc2.zip
fix doc/building
Diffstat (limited to 'doc/building/llvm/GNULinux-GNAT.rst')
-rw-r--r--doc/building/llvm/GNULinux-GNAT.rst31
1 files changed, 14 insertions, 17 deletions
diff --git a/doc/building/llvm/GNULinux-GNAT.rst b/doc/building/llvm/GNULinux-GNAT.rst
index 3733d763f..5f97c99b7 100644
--- a/doc/building/llvm/GNULinux-GNAT.rst
+++ b/doc/building/llvm/GNULinux-GNAT.rst
@@ -1,26 +1,23 @@
-.. _BUILD:mcode:GNULinux-GNAT:
+.. _BUILD:llvm:GNULinux-GNAT:
-GNU/Linux with GCC/GNAT
-#######################
+LLVM Backend on GNU/Linux with GCC/GNAT
+#######################################
-On Linux, GHDL is configured by ``configure`` and build by ``make``.
+.. HINT:: You need to install LLVM (usually depends on ``libedit``, see :ghdlsharp:`29`). The supported versions are 3.5 till 5.0, but debugging is only supported with LLVM 3.5.
-* First, GHDL needs to be configured. It is common to specify a PREFIX
- (installation directory like ``/usr/local`` or ``/opt/ghdl``). Without any
- other option, ``configure`` select `mcode` as backend.
+* First configure GHDL with the proper arg ``./configure --with-llvm-config``. If ``llvm-config`` is not in your path, you can specify it: ``./configure --with-llvm-config=LLVM_INSTALL/bin/llvm-config``.
-* Next, ``make`` starts the compilation process.
-
-* Finally, ``make install`` installs GHDL into the installation directory
- specified by PREFIX. You may need super user privileges (``sudo ...``).
+* Then, build with ``make`` and install with ``make install``.
.. rubric:: Example:
.. code-block:: Bash
- cd <ghdl>
- mkdir build
- cd build
- ../configure --prefix=PREFIX
- make
- sudo make install
+ $ cd <ghdl>
+ $ mkdir build
+ $ cd build
+ $ ../configure --with-llvm-config --prefix=PREFIX
+ $ make
+ $ make install
+
+.. HINT:: If you want to have stack backtraces on errors (like assert failure or index of out bounds), you need to configure and build ``libbacktrace`` from GCC (you don't need to configure GCC). Then add the following arg to configure: ``--with-backtrace-lib=/path-to-gcc-build/libbacktrace/.libs/libbacktrace.a``