diff options
author | Freddie Liardet <frederick.liardet@arm.com> | 2021-08-06 09:12:26 +0100 |
---|---|---|
committer | frederick.liardet <frederick.liardet@arm.com> | 2021-08-06 09:05:07 +0000 |
commit | f289e57eaaf61b0e5a47a00a76e36c61947c7312 (patch) | |
tree | 572f829ac100d362e962d56bf710689f99afe6ea /docs | |
parent | dc43a98f0ff531b60ad8b0b5d44174927ed4c6c2 (diff) | |
download | ComputeLibrary-f289e57eaaf61b0e5a47a00a76e36c61947c7312.tar.gz |
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>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/user_guide/how_to_build_and_run_examples.dox | 16 |
1 files changed, 13 insertions, 3 deletions
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 1766199eb4..35229f778a 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 @@ To see the build options available simply run ```scons -h```: 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 @@ Example: @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 @@ In order to use this option, the external tests directory must have the followin 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 ? |