diff options
| author | Michele Di Giorgio <michele.digiorgio@arm.com> | 2020-10-28 17:27:14 +0000 |
|---|---|---|
| committer | Michele Di Giorgio <michele.digiorgio@arm.com> | 2020-11-03 09:57:04 +0000 |
| commit | 674d74866109b13c849f265c3097402c95d7788e (patch) | |
| tree | b5de56fc139126496c3f8dd5b29050a8612c03b5 | |
| parent | 70ddabcd07e79cdc5409e286aaf4aaea5b202b7a (diff) | |
| download | ComputeLibrary-674d74866109b13c849f265c3097402c95d7788e.tar.gz | |
COMPMID-3599: Remove directory structure from tests documentation
Relevant descriptions are moved to the ComputeLibrary.dir file so that
they can be shown under the `Files` tab.
Change-Id: I8e9b22c90d452e9fbb509460db28ad9cf87c9fa0
Signed-off-by: Michele Di Giorgio <michele.digiorgio@arm.com>
Reviewed-on: https://review.mlplatform.org/c/ml/ComputeLibrary/+/4303
Tested-by: Arm Jenkins <bsgcomp@arm.com>
Reviewed-by: Georgios Pinitas <georgios.pinitas@arm.com>
Comments-Addressed: Arm Jenkins <bsgcomp@arm.com>
| -rw-r--r-- | docs/02_tests.dox | 22 | ||||
| -rw-r--r-- | docs/ComputeLibrary.dir | 4 |
2 files changed, 4 insertions, 22 deletions
diff --git a/docs/02_tests.dox b/docs/02_tests.dox index a813844403..c46e1f5663 100644 --- a/docs/02_tests.dox +++ b/docs/02_tests.dox @@ -45,28 +45,6 @@ information is needed within the test (e.g. to validate the results). @note Tests are not included in the pre-built binary archive, you have to build them from sources. -@subsection tests_overview_structure Directory structure - - . - `-- tests <- Top level test directory. All files in here are shared among validation and benchmark. - |-- framework <- Underlying test framework. - |-- CL \ - |-- GLES_COMPUTE \ - |-- NEON -> Backend specific files with helper functions etc. - |-- benchmark <- Top level directory for the benchmarking files. - | |-- fixtures <- Fixtures for benchmark tests. - | |-- CL <- OpenCL backend test cases on a function level. - | |-- GLES_COMPUTE <- Same of OpenGL ES - | `-- NEON <- Same for NEON - |-- datasets <- Datasets for benchmark and validation tests. - |-- main.cpp <- Main entry point for the tests. Currently shared between validation and benchmarking. - `-- validation -> Top level directory for validation files. - |-- CPP -> C++ reference code - |-- CL \ - |-- GLES_COMPUTE \ - |-- NEON -> Backend specific test cases - `-- fixtures -> Fixtures shared among all backends. Used to setup target function and tensors. - @subsection tests_overview_fixtures Fixtures Fixtures can be used to share common setup, teardown or even run tasks among diff --git a/docs/ComputeLibrary.dir b/docs/ComputeLibrary.dir index 52f1a806f6..c325af29fd 100644 --- a/docs/ComputeLibrary.dir +++ b/docs/ComputeLibrary.dir @@ -295,6 +295,10 @@ * @brief All test related files shared between validation and benchmark. */ +/** @file tests/main.cpp + * @brief Main entry point for the tests. Currently shared between validation and benchmarking. + */ + /** @dir tests/CL * @brief OpenCL accessors. */ |