From 8bec39b66aefc0efde27d2a5109fa34f5d454eec Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Wed, 4 Dec 2024 21:10:21 +0100 Subject: [PATCH] doc/radosgw: edit uadk-accel.rst Make most of the changes to doc/radosgw/uadk-accel.rst suggested by Anthony D'Atri in https://github.com/ceph/ceph/pull/59514. Co-authored-by: Anthony D'Atri Signed-off-by: Zac Dover --- doc/radosgw/uadk-accel.rst | 31 ++++++++++++++++--------------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/doc/radosgw/uadk-accel.rst b/doc/radosgw/uadk-accel.rst index fdf99f891f0..9e4d289b541 100644 --- a/doc/radosgw/uadk-accel.rst +++ b/doc/radosgw/uadk-accel.rst @@ -33,10 +33,10 @@ See `OpenSSL UADK Engine`_. UADK Environment Setup ====================== -UADK consists of UACCE, vendors’ drivers, and an algorithm layer. UADK requires the -hardware accelerator to support SVA, and the operating system to support IOMMU and -SVA. Hardware accelerators from different vendors are registered as different character -devices with UACCE by using kernel-mode drivers of the vendors. +UADK consists of UACCE, vendor drivers, and an algorithm layer. UADK requires +the hardware accelerator to support SVA, and the operating system to support +IOMMU and SVA. Hardware accelerators are registered as different character +devices with UACCE by kernel-mode drivers. :: @@ -77,11 +77,11 @@ Configuration #. Kernel Requirement -User needs to make sure that UACCE is already supported in Linux kernel. The kernel version -should be at least v5.9 with SVA (Shared Virtual Addressing) enabled. +Users need to ensure that UACCE is supported by the Linux kernel release in +use, which should be 5.9 or later with SVA (Shared Virtual Addressing) enabled. -UACCE may be built as a module or built into the kernel. Here's an example to build UACCE -with hardware accelerators for the HiSilicon Kunpeng platform. +UACCE may be built as a module or built into the kernel. Here's an example to +build UACCE with hardware accelerators for the HiSilicon Kunpeng platform. .. prompt:: bash $ @@ -97,9 +97,9 @@ with hardware accelerators for the HiSilicon Kunpeng platform. Make sure all these above kernel configurations are selected. #. UADK enablement -If the architecture is aarch64, it will automatically download the UADK source code to build -the static library. If it runs on other architecture, user can enable it with build parameters -`-DWITH_UADK=true` +If the architecture is aarch64, it will automatically download the UADK source +code to build the static library. If it runs on other architecture, user can +enable it with build parameters `-DWITH_UADK=true` #. Manual Build UADK As the above paragraph shows, the UADK is enabled automatically, no need to build manually. @@ -115,9 +115,9 @@ For developer who is interested in UADK, you can refer to the below steps for bu make make install - .. note:: Without –prefix, UADK will be installed to /usr/local/lib by - default. If get error:"cannot find -lnuma", please install - the `libnuma-dev`. + .. note:: Without –prefix, UADK will be installed to ``/usr/local/lib`` by + default. If you get the error: ``cannot find -lnuma``, install the + ``libnuma-dev`` package. #. Configure @@ -126,7 +126,8 @@ For developer who is interested in UADK, you can refer to the below steps for bu uadk_compressor_enabled=true - The default value in `global.yaml.in` for `uadk_compressor_enabled` is false. + The default value in `global.yaml.in` for `uadk_compressor_enabled` is + ``false``. .. _Compressor UADK Support: https://github.com/ceph/ceph/pull/58336 .. _OpenSSL UADK Engine: https://github.com/Linaro/uadk_engine -- 2.39.5