diff options
author | Patrick Lehmann <Patrick.Lehmann@tu-dresden.de> | 2017-03-04 20:36:18 +0100 |
---|---|---|
committer | tgingold <tgingold@users.noreply.github.com> | 2017-12-10 12:02:05 +0100 |
commit | 3f5cd97cc29039f8f153541808ca85938c00eef4 (patch) | |
tree | a4877e168191ef1e888f3a37fd7b46ece7daebb6 /doc/building/mcode | |
parent | f38b0364b5a769eb97e87c6fbf5fc303101883d2 (diff) | |
download | ghdl-3f5cd97cc29039f8f153541808ca85938c00eef4.tar.gz ghdl-3f5cd97cc29039f8f153541808ca85938c00eef4.tar.bz2 ghdl-3f5cd97cc29039f8f153541808ca85938c00eef4.zip |
Restructured build section. Created smaller files. Created (hidden) sub-ToCs. Added out-dated build instructions for Windows GNAT GPL flow from private README.md.
Diffstat (limited to 'doc/building/mcode')
-rw-r--r-- | doc/building/mcode/GNULinux-GNAT.rst | 27 | ||||
-rw-r--r-- | doc/building/mcode/Windows-GNATGPL.rst | 36 | ||||
-rw-r--r-- | doc/building/mcode/Windows-MinGW-GNAT.rst | 26 | ||||
-rw-r--r-- | doc/building/mcode/index.rst | 28 |
4 files changed, 117 insertions, 0 deletions
diff --git a/doc/building/mcode/GNULinux-GNAT.rst b/doc/building/mcode/GNULinux-GNAT.rst new file mode 100644 index 000000000..8443c254f --- /dev/null +++ b/doc/building/mcode/GNULinux-GNAT.rst @@ -0,0 +1,27 @@ +.. _BUILD:mcode:GNULinux-GNAT: + +GHDL with mcode backend build on GNU/Linux with GCC/GNAT +######################################################## + +On Linux, GHDL is configured by ``configure`` and build by ``make``. + +* 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. + +* 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 ...``). + + +.. rubric:: Example: + +.. code-block:: Bash + + cd <ghdl> + mkdir build + cd build + ../configure --prefix=PREFIX + make + sudo make install diff --git a/doc/building/mcode/Windows-GNATGPL.rst b/doc/building/mcode/Windows-GNATGPL.rst new file mode 100644 index 000000000..d17fe11a8 --- /dev/null +++ b/doc/building/mcode/Windows-GNATGPL.rst @@ -0,0 +1,36 @@ +.. _BUILD:mcode:Windows-GNATGPL: + +GHDL with mcode backend build on Windows with GNAT GPL +###################################################### + +Requirements +============ + +* GNAT GPL from http://libre.adacore.com +* PowerShell 4 +* PowerShell Community Extensions (PSCX) + + +Scripts and Parameters +====================== + +`compile.ps1` +------------- + +.. code-block:: plain + + Commands Description + -------------------------------------------------------------------- + -Help Display the integrated help pages + -Clean Clean up all files and directories + -Compile Compile GHDL + -Install Install all files into a directory (xcopy deployment) + -Uninstall Uninstall all files from a directory + -Update Update files in the installation directory + -CreatePackage create an installer package + + Install options: + -InstallPath Installation directory + + CreatePackage options: + -Zip Create a zip-file for xcopy deployment diff --git a/doc/building/mcode/Windows-MinGW-GNAT.rst b/doc/building/mcode/Windows-MinGW-GNAT.rst new file mode 100644 index 000000000..874807bcf --- /dev/null +++ b/doc/building/mcode/Windows-MinGW-GNAT.rst @@ -0,0 +1,26 @@ +.. _BUILD:mcode:Windows-MinGW-GNAT: + +GHDL with mcode backend build on Windows with GCC/GNAT (MinGW) +############################################################## + +On Windows with MinGW, GHDL is configured by ``configure`` and build by ``make``. + +* 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. + +* Next, ``make`` starts the compilation process. + +* Finally, ``make install`` installs GHDL into the installation directory + specified by ``PREFIX``. + +.. rubric:: Example: + +.. code-block:: Bash + + cd <ghdl> + mkdir build + cd build + ../configure --prefix=PREFIX + make + make install diff --git a/doc/building/mcode/index.rst b/doc/building/mcode/index.rst new file mode 100644 index 000000000..3dc80c2f9 --- /dev/null +++ b/doc/building/mcode/index.rst @@ -0,0 +1,28 @@ +.. _BUILD:mcode: + +Mcode Backend +############# + +The mcode backend is available for all supported platforms and is also the most +simplest procedure, because it requires the least dependencies and configuration +options. + + +.. rubric:: Requirements + +* GCC (Gnu Compiler Collection) +* GNAT (Ada compiler for GCC) + + +.. rubric:: Supported platforms + +* :ref:`GNU/Linux with GCC <BUILD:mcode:GNULinux-GNAT>` +* :ref:`Windows (x86_64) with GNAT GPL (x86) <BUILD:mcode:Windows-GNATGPL>` +* :ref:`Windows (x86_64) with MinGW32/MinGW64 <BUILD:mcode:Windows-WinGW-GNAT>` + +.. toctree:: + :hidden: + + GNU/Linux with GCC/GNAT <GNULinux-GNAT> + Windows with GNAT GPL <Windows-GNATGPL> + Windows with GCC/GNAT (MinGW) <Windows-MinGW-GNAT> |