From b7dcd51596fccf0f12b6e5566268beeea7dfb697 Mon Sep 17 00:00:00 2001
From: Avinash Mehta <avinash.mehta@arm.com>
Date: Fri, 30 Jul 2021 10:09:02 +0000
Subject: [PATCH] totalcompute/tc0: minor changes to the user guide

This commit makes minor changes to the user guide to improve the
readablity of the page

Signed-off-by: Avinash Mehta <avinash.mehta@arm.com>
---
 docs/totalcompute/tc0/user-guide.rst | 31 ++++++++++++++++++++++------
 1 file changed, 25 insertions(+), 6 deletions(-)

diff --git a/docs/totalcompute/tc0/user-guide.rst b/docs/totalcompute/tc0/user-guide.rst
index 11c20bb..da6872b 100755
--- a/docs/totalcompute/tc0/user-guide.rst
+++ b/docs/totalcompute/tc0/user-guide.rst
@@ -45,8 +45,10 @@ To get the latest repo tool from google, run the following commands:
 
 ::
 
+    mkdir -p ~/bin
     curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo
     chmod a+x ~/bin/repo
+    export PATH=~/bin:$PATH
 
 If syncing and building android, the minimum requirements for the host machine can be found at https://source.android.com/setup/build/requirements, These include:
  * At least 250GB of free disk space to check out the code and an extra 150 GB to build it. If you conduct multiple builds, you need additional space.
@@ -163,13 +165,17 @@ with the modifications
 ::
 
     cd <tc0_workspace>/bsp
-    MACHINE=tc0 DISTRO=poky . ./conf/setup-environment
+    MACHINE=tc0
+    DISTRO=poky
+    . ./conf/setup-environment
+
     # create a workspace for a given recipe component
     # recipe-component-name can be of:
     # trusted-firmware-a / scp-firmware / u-boot / linux-arm64-ack
     devtool modify <recipe-component-name>
+
     # This creates a new workspace for recipe-component-name and fetches source code
-    # into "build-poky/workspace/sources/{trusted-firmware-a,scp-firmware,u-boot,linux-arm64-ack}"
+    # into "<tc0_workspace>/build-poky/workspace/sources/{trusted-firmware-a,scp-firmware,u-boot,linux-arm64-ack}"
     # edit the source code in the newly created workspace
     # build images with changes on workspace
     # recipe-component-name can be of: trusted-firmware-a / scp-firmware / u-boot / linux-arm64-ack
@@ -264,6 +270,9 @@ The recipe responsible for building a 5.10 version of the Android Common kernel
 +--------+-----------------------------------------------------------------------------------------------+
 
 
+Distributions
+#############
+
 Poky Linux distro
 *****************
 
@@ -309,7 +318,7 @@ The run-scripts structure is as follows:
     run-scripts
     |--tc0
        |--run_model.sh
-       |-- ...
+       |-- ...
 
 Ensure that all dependencies are met by running the FVP: ``./path/to/FVP_TC0``. You should see
 the FVP launch, presenting a graphical interface showing information about the current state of the FVP.
@@ -328,12 +337,22 @@ the previously built images as arguments. Run the ``run_model.sh`` script:
        -a, --avb                        [OPTIONAL] avb boot, values supported [true, false], DEFAULT: false
        -t, --tap-interface              [OPTIONAL] enable TAP interface
        -e, --extra-model-params	        [OPTIONAL] extra model parameters
-       If using an android distro, export ANDROID_PRODUCT_OUT variable to point to android out directory
-       for eg. ANDROID_PRODUCT_OUT=<tc0_workspace>/android/out/target/product/tc0_swr
 
-       For running Poky:
+Running Poky
+############
+
+::
+
         ./run-scripts/tc0/run_model.sh -m <model binary path> -d poky
 
+Running Android
+###############
+
+::
+
+       If using an android distro, export ANDROID_PRODUCT_OUT variable to point to android out directory
+       for eg. ANDROID_PRODUCT_OUT=<tc0_workspace>/android/out/target/product/tc0_swr
+
        For running android with AVB disabled:
         ./run-scripts/tc0/run_model.sh -m <model binary path> -d android-swr
         OR
-- 
GitLab