From 3f5cd97cc29039f8f153541808ca85938c00eef4 Mon Sep 17 00:00:00 2001
From: Patrick Lehmann <Patrick.Lehmann@tu-dresden.de>
Date: Sat, 4 Mar 2017 20:36:18 +0100
Subject: Restructured build section. Created smaller files. Created (hidden)
 sub-ToCs. Added out-dated build instructions for Windows GNAT GPL flow from
 private README.md.

---
 doc/building/mcode/GNULinux-GNAT.rst      | 27 +++++++++++++++++++++++
 doc/building/mcode/Windows-GNATGPL.rst    | 36 +++++++++++++++++++++++++++++++
 doc/building/mcode/Windows-MinGW-GNAT.rst | 26 ++++++++++++++++++++++
 doc/building/mcode/index.rst              | 28 ++++++++++++++++++++++++
 4 files changed, 117 insertions(+)
 create mode 100644 doc/building/mcode/GNULinux-GNAT.rst
 create mode 100644 doc/building/mcode/Windows-GNATGPL.rst
 create mode 100644 doc/building/mcode/Windows-MinGW-GNAT.rst
 create mode 100644 doc/building/mcode/index.rst

(limited to 'doc/building/mcode')

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>
-- 
cgit v1.2.3