diff options
| author | SiCong Li <sicong.li@arm.com> | 2019-11-21 18:22:38 +0000 |
|---|---|---|
| committer | SiCong Li <sicong.li@arm.com> | 2019-11-25 15:56:47 +0000 |
| commit | 6d8b94ac6864dfd7ad38bc110006bdca5ee0f266 (patch) | |
| tree | 9535e9a8853e0cc4c0691ec7099efae4e6b539b6 /docs | |
| parent | b71d224ef2629f7bc7ea70be258a2f11a10600b7 (diff) | |
| download | ComputeLibrary-6d8b94ac6864dfd7ad38bc110006bdca5ee0f266.tar.gz | |
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 <sicong.li@arm.com>
Change-Id: I30cd29892cea49ffa5c80370bc91ccd3407f5d26
Reviewed-on: https://review.mlplatform.org/c/2350
Comments-Addressed: Arm Jenkins <bsgcomp@arm.com>
Reviewed-by: Michele Di Giorgio <michele.digiorgio@arm.com>
Tested-by: Arm Jenkins <bsgcomp@arm.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/00_introduction.dox | 2 | ||||
| -rw-r--r-- | docs/01_library.dox | 2 | ||||
| -rw-r--r-- | docs/02_tests.dox | 2 | ||||
| -rw-r--r-- | docs/03_scripts.dox | 4 | ||||
| -rw-r--r-- | docs/04_adding_operator.dox | 2 | ||||
| -rw-r--r-- | docs/07_errata.dox | 41 | ||||
| -rw-r--r-- | docs/Doxyfile | 1 |
7 files changed, 48 insertions, 6 deletions
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 36ef2bca58..835aa00a05 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/ \ |