From 66f2a8891f4c0fd49433280be06e5e007491e044 Mon Sep 17 00:00:00 2001
From: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
Date: Wed, 31 Jul 2019 17:57:58 +0200
Subject: docs: Add macos build documentation

Type: docs

Change-Id: Iee03aacab2cfcb4e87190302dc641e8273b7f096
Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
---
 .../developers/cross_compile_macos.rst             | 57 ++++++++++++++++++++++
 docs/gettingstarted/developers/index.rst           |  1 +
 2 files changed, 58 insertions(+)
 create mode 100644 docs/gettingstarted/developers/cross_compile_macos.rst

(limited to 'docs/gettingstarted/developers')

diff --git a/docs/gettingstarted/developers/cross_compile_macos.rst b/docs/gettingstarted/developers/cross_compile_macos.rst
new file mode 100644
index 00000000000..932f86549f6
--- /dev/null
+++ b/docs/gettingstarted/developers/cross_compile_macos.rst
@@ -0,0 +1,57 @@
+.. _cross_compile_macos :
+
+Cross compilation on MacOS
+==========================
+
+This is a first attempt to support Cross compilation of VPP on MacOS for development (linting, completion, compile_commands.json)
+
+
+**Prerequisites**
+
+* You'll need to install the following packages
+
+.. code-block:: bash
+
+  pip3 install ply
+  brew install diffutils gnu-sed pkg-config ninja crosstool-ng
+
+* You'll also need to install ``gnu-ident 2.2.11`` to be able to ``make checkstyle``. You can get it from `GNU <https://www.gnu.org/prep/ftp.html>`_
+* You should link the binaries to make them available in your path with their original names e.g. :
+
+.. code-block:: bash
+
+  ln -s $(which gsed) /usr/local/bin/sed
+  ln -s $(which gindent) /usr/local/bin/indent
+  ln -s /usr/local/Cellar/diffutils/3.7/bin/diff /usr/local/bin/diff
+
+
+**Setup**
+
+* Create a `cross compile toolchain <https://crosstool-ng.github.io/>`_
+* Create a case sensitive volume and mount the toolchain in it e.g. in ``/Volumes/xchain``
+* Create a xchain.toolchain file with ``$VPP_DIR/extras/scripts/cross_compile_macos.sh conf /Volumes/xchan``
+
+For now we don't support e-build so dpdk, rdma, quicly won't be compiled as part of ``make build``
+
+To build with the toolchain do:
+
+.. code-block:: bash
+
+  $VPP_DIR/extras/scripts/cross_compile_macos.sh build
+
+
+To get the compile_commands.json do
+
+.. code-block:: bash
+
+  $VPP_DIR/extras/scripts/cross_compile_macos.sh cc
+  # >> ./build-root/build-vpp[_debug]-native/vpp/compile_commands.json
+
+
+
+This should build vpp on MacOS
+
+
+Good luck :)
+
+
diff --git a/docs/gettingstarted/developers/index.rst b/docs/gettingstarted/developers/index.rst
index 2d27da99ba8..93f4e33ee7f 100644
--- a/docs/gettingstarted/developers/index.rst
+++ b/docs/gettingstarted/developers/index.rst
@@ -40,3 +40,4 @@ The Developers section covers the following areas:
    buildwireshark
    punt
    quic_plugin
+   cross_compile_macos.rst
-- 
cgit 1.2.3-korg