Update build documentation
Add "hight_priority" and "data_layout_support" to build docs.
Resolves: COMPMID-4742
Signed-off-by: Freddie Liardet <frederick.liardet@arm.com>
Change-Id: Ib95514357c1d4a30025f2c2906d029d074521a66
Reviewed-on: https://review.mlplatform.org/c/ml/ComputeLibrary/+/6055
Comments-Addressed: Arm Jenkins <bsgcomp@arm.com>
Tested-by: Arm Jenkins <bsgcomp@arm.com>
Reviewed-by: Michele Di Giorgio <michele.digiorgio@arm.com>
diff --git a/docs/user_guide/how_to_build_and_run_examples.dox b/docs/user_guide/how_to_build_and_run_examples.dox
index 1766199..35229f7 100644
--- a/docs/user_guide/how_to_build_and_run_examples.dox
+++ b/docs/user_guide/how_to_build_and_run_examples.dox
@@ -153,6 +153,12 @@
external_tests_dir: Add examples, benchmarks and tests to the tests suite from an external path ( /path/to/external_tests_dir )
default:
+ high_priority: Generate a library using only the high priority operators
+ default: False
+
+ data_layout_support: Enable a list of data layout to support
+ default: False
+
@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)
@@ -201,15 +207,15 @@
@b mali: Enable the collection of Arm® Mali™ hardware counters to measure execution time in benchmark tests. (Your device needs to have a Arm® Mali™ driver that supports it)
-@b openmp Build in the OpenMP scheduler for Neon™.
+@b openmp: Build in the OpenMP scheduler for Neon™.
@note Only works when building with g++ not clang++
-@b cppthreads Build in the C++11 scheduler for Neon™.
+@b cppthreads: Build in the C++11 scheduler for Neon™.
@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 )
+@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:
@@ -228,6 +234,10 @@
Then, build the library with `external_tests_dir=<PATH_TO_EXTERNAL_TESTS_DIR>`.
+@b high_priority: Generate a library using only the high priority operators
+
+@b data_layout_support: Enable a list of data layout to support
+
@section S1_2_linux Building for Linux
@subsection S1_2_1_library How to build the library ?