[RESEND] crypto: qat - fix indentation in ABI documentation

Commit Message

Cabiddu, Giovanni July 11, 2022, 6:01 p.m. UTC

On Mon, Jul 11, 2022 at 05:29:52PM +0100, Giovanni Cabiddu wrote:
> Resending including linux-crypto. Apologies for the duplicate.
Ouch, now I see that it didn't get picked up by
https://patchwork.kernel.org/project/linux-crypto/list/.
Re-sending again, now with the correct subject. Apologies.

----8<----

From: Giovanni Cabiddu <[e-mail]>
Date: Mon, 11 Jul 2022 16:18:43 +0100
Subject: [PATCH] crypto: qat - fix indentation in ABI documentation
Organization: Intel Research and Development Ireland Ltd - Co. Reg. #308263 - Collinstown Industrial Park, Leixlip, County Kildare - Ireland

Change the indentation in the file sysfs-driver-qat to resolve the
following warning when generating documentation with `make htmldocs`:

    Documentation/ABI/testing/sysfs-driver-qat:24: WARNING: Unexpected indentation.

Fixes: d4cfb144f605 ("crypto: qat - expose device config through sysfs for 4xxx")
Reported-by: kernel test robot <[e-mail]>
Signed-off-by: Giovanni Cabiddu <[e-mail]>
---
 Documentation/ABI/testing/sysfs-driver-qat | 38 ++++++++++------------
 1 file changed, 17 insertions(+), 21 deletions(-)

Comments

Bagas Sanjaya July 12, 2022, 10:33 a.m. UTC | #1

On 7/12/22 01:01, Giovanni Cabiddu wrote:
> @@ -47,14 +43,14 @@ 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:
> -			# cat /sys/bus/pci/devices/<BDF>/qat/state
> -			up
> -			# cat /sys/bus/pci/devices/<BDF>/qat/cfg_services
> -			sym;asym
> -			# echo down > /sys/bus/pci/devices/<BDF>/qat/state
> -			# echo dc > /sys/bus/pci/devices/<BDF>/qat/cfg_services
> -			# echo up > /sys/bus/pci/devices/<BDF>/qat/state
> -			# cat /sys/bus/pci/devices/<BDF>/qat/cfg_services
> -			dc
> +		# cat /sys/bus/pci/devices/<BDF>/qat/state
> +		up
> +		# cat /sys/bus/pci/devices/<BDF>/qat/cfg_services
> +		sym;asym
> +		# echo down > /sys/bus/pci/devices/<BDF>/qat/state
> +		# echo dc > /sys/bus/pci/devices/<BDF>/qat/cfg_services
> +		# echo up > /sys/bus/pci/devices/<BDF>/qat/state
> +		# cat /sys/bus/pci/devices/<BDF>/qat/cfg_services
> +		dc
>  
>  		This attribute is only available for qat_4xxx devices.

Hi,

I think the culprit is just missing code block marker, which is added
above. Thanks.

Cabiddu, Giovanni July 12, 2022, 11:36 a.m. UTC | #2

Hi Bagas,

On Tue, Jul 12, 2022 at 05:33:45PM +0700, Bagas Sanjaya wrote:
> Hi,
> 
> I think the culprit is just missing code block marker, which is added
> above. Thanks.
Thanks for your fixes!

This patch should be ignore.

Regards,

Patch

diff --git a/Documentation/ABI/testing/sysfs-driver-qat b/Documentation/ABI/testing/sysfs-driver-qat
index a600531e9562..741d97fa5ae1 100644
--- a/Documentation/ABI/testing/sysfs-driver-qat
+++ b/Documentation/ABI/testing/sysfs-driver-qat
@@ -8,12 +8,12 @@  Description:	Reports the current state of the QAT device and allows to
 		This attribute is RW.
 
 		Returned values:
-			up: the device is up and running
-			down: the device is down
+		up: the device is up and running
+		down: the device is down
 
 		Allowed values:
-			up: initialize and start the device
-			down: stop the device and bring it down
+		up: initialize and start the device
+		down: stop the device and bring it down
 
 		It is possible to transition the device from up to down only
 		if the device is up and vice versa.
@@ -30,16 +30,12 @@  Description:	Reports the current configuration of the QAT device and allows
 		This attribute is RW.
 
 		Returned values:
-			sym;asym:	the device is configured for running
-					crypto services
-			dc:		the device is configured for running
-					compression services
+		sym;asym:  the device is configured for running crypto services
+		dc:        the device is configured for running compression services
 
 		Allowed values:
-			sym;asym:	configure the device for running
-					crypto services
-			dc:		configure the device for running
-					compression services
+		sym;asym:  configure the device for running crypto services
+		dc:        configure the device for running compression services
 
 		It is possible to set the configuration only if the device
 		is in the `down` state (see /sys/bus/pci/devices/<BDF>/qat/state)
@@ -47,14 +43,14 @@  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:
-			# cat /sys/bus/pci/devices/<BDF>/qat/state
-			up
-			# cat /sys/bus/pci/devices/<BDF>/qat/cfg_services
-			sym;asym
-			# echo down > /sys/bus/pci/devices/<BDF>/qat/state
-			# echo dc > /sys/bus/pci/devices/<BDF>/qat/cfg_services
-			# echo up > /sys/bus/pci/devices/<BDF>/qat/state
-			# cat /sys/bus/pci/devices/<BDF>/qat/cfg_services
-			dc
+		# cat /sys/bus/pci/devices/<BDF>/qat/state
+		up
+		# cat /sys/bus/pci/devices/<BDF>/qat/cfg_services
+		sym;asym
+		# echo down > /sys/bus/pci/devices/<BDF>/qat/state
+		# echo dc > /sys/bus/pci/devices/<BDF>/qat/cfg_services
+		# echo up > /sys/bus/pci/devices/<BDF>/qat/state
+		# cat /sys/bus/pci/devices/<BDF>/qat/cfg_services
+		dc
 
 		This attribute is only available for qat_4xxx devices.