Re: [PATCH RESEND v2 1/2] Documentation: qat: Use code block for qat sysfs example

From: Vlad Dronov
Date: Wed Jul 13 2022 - 09:01:21 EST


Hi,

On Wed, Jul 13, 2022 at 10:57 AM Bagas Sanjaya <bagasdotme@xxxxxxxxx> wrote:
> kernel test robot and Stephen Rothwell reported htmldocs warning:
>
> Documentation/ABI/testing/sysfs-driver-qat:24: WARNING: Unexpected indentation.
>
> The warning isn't caused by Date: field pointed by the warning, but rather
> by sysfs example that isn't in literal code block.
>
> Add the code block marker.
>
> Link: https://lore.kernel.org/linux-next/20220711204932.333379b4@xxxxxxxxxxxxxxxx/
> Link: https://lore.kernel.org/linux-doc/202207090803.TEGI95qw-lkp@xxxxxxxxx/
> Reported-by: kernel test robot <lkp@xxxxxxxxx>
> Reported-by: Stephen Rothwell <sfr@xxxxxxxxxxxxxxxx>
> Fixes: d4cfb144f60551 ("crypto: qat - expose device config through sysfs for 4xxx")
> Acked-by: Giovanni Cabiddu <giovanni.cabiddu@xxxxxxxxx>
> Cc: Wojciech Ziemba <wojciech.ziemba@xxxxxxxxx>
> Cc: Adam Guerin <adam.guerin@xxxxxxxxx>
> Cc: Fiona Trahe <fiona.trahe@xxxxxxxxx>
> Cc: Herbert Xu <herbert@xxxxxxxxxxxxxxxxxxx>
> Cc: Vladis Dronov <vdronov@xxxxxxxxxx>
> Cc: Tomasz Kowallik <tomaszx.kowalik@xxxxxxxxx>
> Cc: linux-crypto@xxxxxxxxxxxxxxx
> Cc: linux-kernel@xxxxxxxxxxxxxxx
> Signed-off-by: Bagas Sanjaya <bagasdotme@xxxxxxxxx>
> ---
> Documentation/ABI/testing/sysfs-driver-qat | 3 ++-
> 1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/ABI/testing/sysfs-driver-qat b/Documentation/ABI/testing/sysfs-driver-qat
> index a600531e95628f..43e081ec22cc4a 100644
> --- a/Documentation/ABI/testing/sysfs-driver-qat
> +++ b/Documentation/ABI/testing/sysfs-driver-qat
> @@ -46,7 +46,8 @@ Description: Reports the current configuration of the QAT device and allows
>
> The following example shows how to change the configuration of
> a device configured for running crypto services in order to
> - run data compression:
> + run data compression::
> +
> # cat /sys/bus/pci/devices/<BDF>/qat/state
> up
> # cat /sys/bus/pci/devices/<BDF>/qat/cfg_services
> --

Acked-by: Vladis Dronov <vdronov@xxxxxxxxxx>

Best regards,
Vladis Dronov | Red Hat, Inc. | The Core Kernel | Senior Software Engineer