From ce80c559bec919ccc3a8cce52a4d1d28822b6092 Mon Sep 17 00:00:00 2001 From: SiCong Li Date: Thu, 21 Nov 2019 18:22:38 +0000 Subject: COMPMID-2905 Add Errata section for the previous CLRuntimeContext hang issue Add the errata section to Doxygen, and provide pointer in README Signed-off-by: SiCong Li Change-Id: I30cd29892cea49ffa5c80370bc91ccd3407f5d26 Reviewed-on: https://review.mlplatform.org/c/2350 Comments-Addressed: Arm Jenkins Reviewed-by: Michele Di Giorgio Tested-by: Arm Jenkins --- README.md | 2 +- docs/00_introduction.dox | 2 +- docs/01_library.dox | 2 +- docs/02_tests.dox | 2 +- docs/03_scripts.dox | 4 ++-- docs/04_adding_operator.dox | 2 +- docs/07_errata.dox | 41 +++++++++++++++++++++++++++++++++++++++++ docs/Doxyfile | 1 + 8 files changed, 49 insertions(+), 7 deletions(-) create mode 100644 docs/07_errata.dox diff --git a/README.md b/README.md index 75fa1b25ec..2aeac7f8ba 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ Blogs: - [Happy Birthday ACL!](https://community.arm.com/developer/tools-software/graphics/b/blog/posts/arm-compute-library-19-05-is-coming) -Documentation available here: +Documentation (API, changelogs, build guide, contribution guide, errata, etc.) available here: - [v19.08](https://arm-software.github.io/ComputeLibrary/v19.08/) - [v19.05](https://arm-software.github.io/ComputeLibrary/v19.05/) diff --git a/docs/00_introduction.dox b/docs/00_introduction.dox index 7179c0d822..7f44fb7479 100644 --- a/docs/00_introduction.dox +++ b/docs/00_introduction.dox @@ -1,5 +1,5 @@ /// -/// Copyright (c) 2017-2018 ARM Limited. +/// Copyright (c) 2017-2019 ARM Limited. /// /// SPDX-License-Identifier: MIT /// diff --git a/docs/01_library.dox b/docs/01_library.dox index 353a979968..28ad5f97ed 100644 --- a/docs/01_library.dox +++ b/docs/01_library.dox @@ -1,5 +1,5 @@ /// -/// Copyright (c) 2017-2018 ARM Limited. +/// Copyright (c) 2017-2019 ARM Limited. /// /// SPDX-License-Identifier: MIT /// diff --git a/docs/02_tests.dox b/docs/02_tests.dox index 2363ae03bf..81edcf2b52 100644 --- a/docs/02_tests.dox +++ b/docs/02_tests.dox @@ -1,5 +1,5 @@ /// -/// Copyright (c) 2017-2018 ARM Limited. +/// Copyright (c) 2017-2019 ARM Limited. /// /// SPDX-License-Identifier: MIT /// diff --git a/docs/03_scripts.dox b/docs/03_scripts.dox index 6b715908dd..e6c19e556f 100644 --- a/docs/03_scripts.dox +++ b/docs/03_scripts.dox @@ -1,5 +1,5 @@ /// -/// Copyright (c) 2017-2018 ARM Limited. +/// Copyright (c) 2017-2019 ARM Limited. /// /// SPDX-License-Identifier: MIT /// @@ -170,4 +170,4 @@ where: This can be useful when parallelizing the validation process is needed. */ -} \ No newline at end of file +} diff --git a/docs/04_adding_operator.dox b/docs/04_adding_operator.dox index 5f03785d98..66ae9a69df 100644 --- a/docs/04_adding_operator.dox +++ b/docs/04_adding_operator.dox @@ -1,5 +1,5 @@ /// -/// Copyright (c) 2018 ARM Limited. +/// Copyright (c) 2018-2019 ARM Limited. /// /// SPDX-License-Identifier: MIT /// diff --git a/docs/07_errata.dox b/docs/07_errata.dox new file mode 100644 index 0000000000..2a8e88334c --- /dev/null +++ b/docs/07_errata.dox @@ -0,0 +1,41 @@ +/// +/// Copyright (c) 2019 ARM Limited. +/// +/// SPDX-License-Identifier: MIT +/// +/// Permission is hereby granted, free of charge, to any person obtaining a copy +/// of this software and associated documentation files (the "Software"), to +/// deal in the Software without restriction, including without limitation the +/// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or +/// sell copies of the Software, and to permit persons to whom the Software is +/// furnished to do so, subject to the following conditions: +/// +/// The above copyright notice and this permission notice shall be included in all +/// copies or substantial portions of the Software. +/// +/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +/// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +/// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +/// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +/// SOFTWARE. +/// +namespace arm_compute +{ +/** +@page errata Errata + +@tableofcontents + +@section S7_1_errata Errata + +- Under certain conditions, benchmark examples can hang when OpenCL profiling queues are enabled. + - Versions Affected: >= v19.11 + - OSs Affected: Linux + - Conditions: + - Mali DDK r1p0 - r8p0, and + - Linux kernel >= 4.4 + +*/ +} // namespace diff --git a/docs/Doxyfile b/docs/Doxyfile index 655ec84a77..64bd966a04 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -775,6 +775,7 @@ INPUT = ./docs/00_introduction.dox \ ./docs/04_adding_operator.dox \ ./docs/05_contribution_guidelines.dox \ ./docs/06_functions_list.dox \ + ./docs/07_errata.dox \ ./arm_compute/ \ ./src/ \ ./examples/ \ -- cgit v1.2.1