aboutsummaryrefslogtreecommitdiff
path: root/build-tool/README.md
diff options
context:
space:
mode:
authorJames Conroy <james.conroy@arm.com>2022-09-22 16:40:00 +0100
committerJames Conroy <james.conroy@arm.com>2022-10-24 11:03:48 +0000
commitc4fbbec63979d99d6cc722aa848896880cc266ec (patch)
treeb10481770dc14ce763b70f36c3a98eadb55a4696 /build-tool/README.md
parent88b902543ded6cf991fee3776f22040240683df4 (diff)
downloadarmnn-c4fbbec63979d99d6cc722aa848896880cc266ec.tar.gz
Make it optional to provide custom ACL to build-tool
* Currently, the build-tool requires the user provide both Arm NN and ACL repos, if providing custom repos. * This change allows the user to provide only a custom Arm NN repo, making a custom ACL optional in the case of --neon-backend or --cl-backend not being chosen in BUILD_ARGS. * Updated script help/usage and docs to reflect this. Signed-off-by: James Conroy <james.conroy@arm.com> Change-Id: I821f07dcd4c32ada60cd33713234b47c330d217e
Diffstat (limited to 'build-tool/README.md')
-rw-r--r--build-tool/README.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/build-tool/README.md b/build-tool/README.md
index a5f946756d..b56a6907c5 100644
--- a/build-tool/README.md
+++ b/build-tool/README.md
@@ -305,9 +305,10 @@ sudo ./install-packages.sh
### Use custom Arm NN and ACL repository versions during build
By default, the docker build process (specifically, during ```build-armnn.sh```) will download the latest release versions of Arm NN and ACL.
-If you'd like to use different versions during the build, check them out in the ```build-tool``` directory on the host (both must be provided).<br>
+If you'd like to use different versions during the build, check them out in the ```build-tool``` directory on the host.<br>
When providing custom repositories, the following ```docker build``` argument must be provided ```--build-arg BUILD_TYPE=dev```.
-This will trigger Docker to copy the custom repos into the Docker Image during build.
+This will trigger Docker to copy the custom repos into the Docker Image during build. The ACL repo is only required if
+supplying the ```--neon-backend``` or ```--cl-backend``` BUILD_ARGS options.
**Note:** the Arm NN version used for build-tool (Dockerfile and scripts) is not the same version of Arm NN that is used during the build.
This means that separate versions of Arm NN can be used for the build-tool and for building Arm NN itself.<br>
@@ -321,13 +322,14 @@ git checkout <branch or SHA>
cd ..
+# custom ACL repo only required when supplying --neon-backend or --cl-backend BUILD_ARGS options
git clone https://github.com/ARM-software/ComputeLibrary.git acl
cd acl
git checkout <tag or SHA>
cd ..
-# Example docker build with BUILD_TYPE=dev
+# Example docker build with BUILD_TYPE=dev, ran inside the build-tool directory
docker build \
--build-arg BUILD_TYPE=dev \
--build-arg SETUP_ARGS="--target-arch=aarch64 --all" \