aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMichele Di Giorgio <michele.digiorgio@arm.com>2020-11-18 15:29:08 +0000
committerMichele Di Giorgio <michele.digiorgio@arm.com>2020-12-17 08:40:07 +0000
commit72610dcf2d634c9c2919ad55245c5c91609e87eb (patch)
treec008e47e360f8e903aa26642c5ab0685d69bb1b5 /docs
parent462e75e217a11b92b8df8c3434f2491ef70487e3 (diff)
downloadComputeLibrary-72610dcf2d634c9c2919ad55245c5c91609e87eb.tar.gz
Remove 3rdparty submodule and internal_only build option
Remove 3rdparty submodule and allow to build external tests, examples and benchmarks using the Compute Library test framework. In order to use this option, the external tests directory must have the following structure: EXTERNAL_TESTS_DIR: └── tests ├── benchmark │   ├── CL │   ├── datasets │   ├── fixtures │   └── NEON └── validation    ├── CL     ├── datasets     ├── fixtures     └── NEON Then, the user can build the library with `external_tests_dir=<PATH_TO_EXTERNAL_TESTS_DIR>`. Also, remove internal_only build option". Without the 3rdparty submodule, this build option is no longer needed. Resolves: COMPMID-3417, COMPMID-3419 Change-Id: Ib7bf8ec7b9b9317fd82012a96bf4a7b0be846c1b Signed-off-by: Michele Di Giorgio <michele.digiorgio@arm.com> Reviewed-on: https://review.mlplatform.org/c/ml/ComputeLibrary/+/4704 Reviewed-by: Georgios Pinitas <georgios.pinitas@arm.com> Tested-by: Arm Jenkins <bsgcomp@arm.com> Comments-Addressed: Arm Jenkins <bsgcomp@arm.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/00_introduction.dox23
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/00_introduction.dox b/docs/00_introduction.dox
index 448025846b..189067c81f 100644
--- a/docs/00_introduction.dox
+++ b/docs/00_introduction.dox
@@ -1481,6 +1481,10 @@ To see the build options available simply run ```scons -h```:
default: False
actual: False
+ external_tests_dir: Add examples, benchmarks and tests to the tests suite from an external path ( /path/to/external_tests_dir )
+ default:
+ actual:
+
@b debug / @b asserts:
- With debug=1 asserts are enabled, and the library is built with symbols and no optimisations enabled.
- With debug=0 and asserts=1: Optimisations are enabled and symbols are removed, however all the asserts are still present (This is about 20% slower than the release build)
@@ -1535,6 +1539,25 @@ Example:
@sa Scheduler::set
+@b external_tests_dir Add examples, benchmarks and tests to the tests suite from an external path ( /path/to/external_tests_dir )
+
+In order to use this option, the external tests directory must have the following structure:
+
+ EXTERNAL_TESTS_DIR:
+ └── tests
+ ├── benchmark
+ │   ├── CL
+ │   ├── datasets
+ │   ├── fixtures
+ │   └── NEON
+ └── validation
+    ├── CL
+     ├── datasets
+     ├── fixtures
+     └── NEON
+
+Then, build the library with `external_tests_dir=<PATH_TO_EXTERNAL_TESTS_DIR>`.
+
@subsection S3_2_linux Building for Linux
@subsubsection S3_2_1_library How to build the library ?