From ad9f14a64f5d821ecfc1f872af9ad61667c91619 Mon Sep 17 00:00:00 2001 From: Mark Horvath Date: Tue, 14 May 2024 15:28:01 +0200 Subject: [PATCH] Improve documentation of build options Reword the description of the KLEIDICV_LIMIT_SVE2_TO_SELECTED_ALGORITHMS option. --- doc/build.md | 2 +- kleidicv/CMakeLists.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/build.md b/doc/build.md index e0ed65a15..727ef295f 100644 --- a/doc/build.md +++ b/doc/build.md @@ -119,4 +119,4 @@ modified at build time via the following CMake options: - `KLEIDICV_BENCHMARK` - Enable building KleidiCV benchmarks. The benchmarks use Google Benchmark which will be downloaded automatically. Off by default. - `KLEIDICV_ENABLE_SME2` - Enable Scalable Matrix Extension 2 and Streaming Scalable Vector Extension code paths if supported by the compiler. On by default. - `KLEIDICV_ENABLE_SVE2` - Enable Scalable Vector Extension 2 code paths if supported by the compiler. On by default. -- `KLEIDICV_LIMIT_SVE2_TO_SELECTED_ALGORITHMS` - Only enable Scalable Vector Extension 2 code paths in cases where it is expected to provide a benefit over other code paths. On by default. Has no effect if `KLEIDICV_ENABLE_SVE2` is false. + - `KLEIDICV_LIMIT_SVE2_TO_SELECTED_ALGORITHMS` - Limit Scalable Vector Extension 2 code paths to cases where it is expected to provide a benefit over other code paths. On by default. Has no effect if `KLEIDICV_ENABLE_SVE2` is false. diff --git a/kleidicv/CMakeLists.txt b/kleidicv/CMakeLists.txt index 1f3969e78..f4446a635 100644 --- a/kleidicv/CMakeLists.txt +++ b/kleidicv/CMakeLists.txt @@ -17,7 +17,7 @@ else() endif() option( KLEIDICV_LIMIT_SVE2_TO_SELECTED_ALGORITHMS - "Enables or disables SVE2 code paths for selected algorithms. Has no effect if KLEIDICV_ENABLE_SVE2 is false." + "Limits SVE2 code paths to selected algorithms. Has no effect if KLEIDICV_ENABLE_SVE2 is false." ON ) option(KLEIDICV_CHECK_BANNED_FUNCTIONS "Internal - Check source for deprecated or obsolescent functions" OFF) -- GitLab