2022-07-12 09:38:34

by Bagas Sanjaya

Subject: [PATCH next 1/3] Documentation: qat: Use code block for qat sysfs example

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/[email protected]/
Link: https://lore.kernel.org/linux-doc/[email protected]/
Reported-by: kernel test robot <[email protected]>
Reported-by: Stephen Rothwell <[email protected]>
Fixes: d4cfb144f60551 ("crypto: qat - expose device config through sysfs for 4xxx")
Cc: Wojciech Ziemba <[email protected]>
Cc: Adam Guerin <[email protected]>
Cc: Fiona Trahe <[email protected]>
Cc: Giovanni Cabiddu <[email protected]>
Cc: Herbert Xu <[email protected]>
Cc: Vladis Dronov <[email protected]>
Cc: Tomasz Kowallik <[email protected]>
Cc: [email protected]
Cc: [email protected]
Signed-off-by: Bagas Sanjaya <[email protected]>
---
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
--
An old man doll... just what I always wanted! - Clara

2022-07-12 11:33:30

by Cabiddu, Giovanni

Subject: Re: [PATCH next 1/3] Documentation: qat: Use code block for qat sysfs example

On Tue, Jul 12, 2022 at 04:29:52PM +0700, Bagas Sanjaya 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/[email protected]/
> Link: https://lore.kernel.org/linux-doc/[email protected]/
> Reported-by: kernel test robot <[email protected]>
> Reported-by: Stephen Rothwell <[email protected]>
> Fixes: d4cfb144f60551 ("crypto: qat - expose device config through sysfs for 4xxx")
> Cc: Wojciech Ziemba <[email protected]>
> Cc: Adam Guerin <[email protected]>
> Cc: Fiona Trahe <[email protected]>
> Cc: Giovanni Cabiddu <[email protected]>
> Cc: Herbert Xu <[email protected]>
> Cc: Vladis Dronov <[email protected]>
> Cc: Tomasz Kowallik <[email protected]>
> Cc: [email protected]
> Cc: [email protected]
> Signed-off-by: Bagas Sanjaya <[email protected]>
Acked-by: Giovanni Cabiddu <[email protected]>

--
Giovanni