aboutsummaryrefslogtreecommitdiffstats
path: root/doc/building/Building.rst
diff options
context:
space:
mode:
author1138-4EB <1138-4EB@users.noreply.github.com>2017-12-09 17:34:58 +0100
committertgingold <tgingold@users.noreply.github.com>2017-12-10 12:02:05 +0100
commit8e06c39ed8311aeb36696d9f964550407e1c556e (patch)
tree5c511441a8c0b2a9bb2f5732dd4284ed725ad24a /doc/building/Building.rst
parent08eb2bfc7144e7698cf570478d6a4e3e81aaf31a (diff)
downloadghdl-8e06c39ed8311aeb36696d9f964550407e1c556e.tar.gz
ghdl-8e06c39ed8311aeb36696d9f964550407e1c556e.tar.bz2
ghdl-8e06c39ed8311aeb36696d9f964550407e1c556e.zip
clean todos
Diffstat (limited to 'doc/building/Building.rst')
-rw-r--r--doc/building/Building.rst27
1 files changed, 4 insertions, 23 deletions
diff --git a/doc/building/Building.rst b/doc/building/Building.rst
index a8d0e6908..f8f939c57 100644
--- a/doc/building/Building.rst
+++ b/doc/building/Building.rst
@@ -7,20 +7,12 @@ Building GHDL from Sources
GHDL can be downloaded as a `zip-file <https://github.com/tgingold/ghdl/archive/master.zip>`_
(latest 'master' branch) or cloned with ``git clone`` from GitHub. GitHub
-offers HTTPS and SSH as transfer protocols. See the :ref:`Download <GETTING:Download>`
+offers HTTPS and SSH as transfer protocols. See the :ref:`RELEASE:Sources`
page for further details. The installation directory is referred to as ``GHDLRoot``.
-+----------+-----------------------------------------------------------+
-| Protocol | Git Clone Command |
-+==========+===========================================================+
-| HTTPS | ``git clone https://github.com/tgingold/ghdl.git ghdl`` |
-+----------+-----------------------------------------------------------+
-| SSH | ``git clone ssh://git@github.com:tgingold/ghdl.git ghdl`` |
-+----------+-----------------------------------------------------------+
-
.. rubric:: Available back-ends
-GHDL currently supports three supported different back-ends (code generators):
+GHDL currently supports three different back-ends (code generators):
* mcode - built-in x86(or x86_64) code generator,
* `GCC - Gnu Compiler Collection <http://gcc.gnu.org/>`_, and
@@ -43,10 +35,10 @@ Here is a short comparison, so that you can choose the one you want to use:
| | * Generated code can be debugged (with ``-g``) | * Analysis can take time (particularly for large units) |
| | * Ported to many platforms (x86, x86_64, PowerPC, SPARC) | * Code coverage collection (``gcov``) is unique to GCC |
+----------------------------+----------------------------------------------------------------------------+---------------------------------------------------------+
-
+
.. toctree::
:hidden:
-
+
Directories
With mcode Backend <mcode/index>
With LLVM Backend <llvm/index>
@@ -69,14 +61,3 @@ created.
(32 or 64 bits). `GNAT GPL` can be downloaded anonymously from `libre.adacore.com <http://libre.adacore.com/tools/gnat-gpl-edition/>`_.
Then, untar and run the doinstall script. Alternatively, most GNU/Linux
provide a package named ``gcc-ada`` or ``gcc-gnat``.
-
-.. TODO::
-
- * @1138 Backtraces optional -patchable-
- * Very briefly, why is mcode faster for analysis and GCC/LLVM for simulation?
- * The only other dependency is zlib (On ubuntu/debian, install zlib1g-dev).
- * From :ghdlsharp:`279`:
- * GCC: GHDL generates an intermediate representation for GCC, which creates an executable. So GHDL acts a a new language frontend like C for the GCC and uses the existing backend to generated e.g. x86(-64) binary code.
- * LLVM: GHDL generates instructions for the LLVM abstract register machine, which then generates x86(-64) instructions for the host system.
- * mcode: GHDL generates the x86(-64) instructions in memory and executes the model.
- * gcc is currently only supported on Linux, because you need to compile a complete GCC from zero and add GHDL as a frontend into the GCC. Compiling the complete GCC suite plus GHDL takes a lot of time. I think it's not possible to finish the compile task in the bounds of a Travis-CI run.