docs: Update and improve indent install
Type: docs
Change-Id: I1a37450261e0bcedf90685243b14027f3cf23704
Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
diff --git a/docs/gettingstarted/developers/cross_compile_macos.rst b/docs/gettingstarted/developers/cross_compile_macos.rst
index 932f865..c5934bc 100644
--- a/docs/gettingstarted/developers/cross_compile_macos.rst
+++ b/docs/gettingstarted/developers/cross_compile_macos.rst
@@ -10,19 +10,19 @@
* 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 @@
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 @@
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>`_