From f681e9f736d34a6fdb7e596f63dfa1f51025a98c Mon Sep 17 00:00:00 2001
From: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
Date: Tue, 8 Sep 2020 18:09:59 +0200
Subject: docs: Update and improve indent install

Type: docs

Change-Id: I1a37450261e0bcedf90685243b14027f3cf23704
Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
---
 .../developers/cross_compile_macos.rst             | 41 +++++++++++++++-------
 1 file changed, 28 insertions(+), 13 deletions(-)

diff --git a/docs/gettingstarted/developers/cross_compile_macos.rst b/docs/gettingstarted/developers/cross_compile_macos.rst
index 932f86549f6..c5934bc9c25 100644
--- a/docs/gettingstarted/developers/cross_compile_macos.rst
+++ b/docs/gettingstarted/developers/cross_compile_macos.rst
@@ -10,19 +10,19 @@ This is a first attempt to support Cross compilation of VPP on MacOS for develop
 
 * You'll need to install the following packages
 
-.. code-block:: bash
+.. code-block:: console
 
-  pip3 install ply
-  brew install diffutils gnu-sed pkg-config ninja crosstool-ng
+  $ pip3 install ply pyyaml jsonschema
+  $ 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'll also need to install ``gnu-ident 2.2.11`` to be able to ``make checkstyle``. This can be done with :ref:`this doc<install_indent_2_2_11>`
 * You should link the binaries to make them available in your path with their original names e.g. :
 
-.. code-block:: bash
+.. code-block:: console
 
-  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
+  $ 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**
@@ -35,17 +35,17 @@ For now we don't support e-build so dpdk, rdma, quicly won't be compiled as part
 
 To build with the toolchain do:
 
-.. code-block:: bash
+.. code-block:: console
 
-  $VPP_DIR/extras/scripts/cross_compile_macos.sh build
+  $ $VPP_DIR/extras/scripts/cross_compile_macos.sh build
 
 
 To get the compile_commands.json do
 
-.. code-block:: bash
+.. code-block:: console
 
-  $VPP_DIR/extras/scripts/cross_compile_macos.sh cc
-  # >> ./build-root/build-vpp[_debug]-native/vpp/compile_commands.json
+  $ $VPP_DIR/extras/scripts/cross_compile_macos.sh cc
+  $ >> ./build-root/build-vpp[_debug]-native/vpp/compile_commands.json
 
 
 
@@ -54,4 +54,19 @@ This should build vpp on MacOS
 
 Good luck :)
 
+.. _install_indent_2_2_11 :
+
+Installing indent 2.2.11
+------------------------
+
+In order to install indent on macos :
+
+.. code-block:: bash
+
+    $ wget http://mirror.sergal.org/gnu/indent/indent-2.2.11.tar.gz
+    $ tar -xzvf indent-2.2.11.tar.gz
+    $ cd indent-2.2.11
+    $ ./configure --disable-dependency-tracking --disable-debug --program-prefix=g --prefix=/usr/local/Cellar/gnu-indent/2.2.11
 
+Install will exit with an error code, but indent 2.2.11 will still be installed in ``/usr/local/bin/gindent``
+Other mirrors can be found on the `GNU website <https://www.gnu.org/prep/ftp.html>`_
-- 
cgit 1.2.3-korg