Skip to contentSkip to conversation

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

PATCH Superseded kernel test robot 4 participants 8 messages Jul 9, 2022 – Jul 12, 2022

Subsystems (2)
lore
Share & tools
lore

kernel test robot

author build bot
#0 lore raw
tree:   https://github.com/ammarfaizi2/linux-block herbert/cryptodev-2.6/master
head:   79e6e2f3f3ff345947075341781e900e4f70db81
commit: d4cfb144f60551d80732c93c892fe76fc8df860d [45/53] crypto: qat - expose device config through sysfs for 4xxx
reproduce: make htmldocs

If you fix the issue, kindly add following tag where applicable

All warnings (new ones prefixed by >>):

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

vim +24 Documentation/ABI/testing/sysfs-driver-qat

  > 24	Date:		June 2022
Signature · 2 lines
0-DAY CI Kernel Test Service
https://01.org/lkp
#1 lore raw
Quoted 5 lines · kernel test robot
tree:   https://github.com/ammarfaizi2/linux-block herbert/cryptodev-2.6/master
head:   79e6e2f3f3ff345947075341781e900e4f70db81
commit: d4cfb144f60551d80732c93c892fe76fc8df860d [45/53] crypto: qat - expose device config through sysfs for 4xxx
reproduce: make htmldocs
Quoted 10 lines

If you fix the issue, kindly add following tag where applicable

All warnings (new ones prefixed by >>):

Quoted 1 line
Quoted 1 line

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

vim +24 Documentation/ABI/testing/sysfs-driver-qat

Quoted 1 line

24 Date: June 2022

I'm not able to spot what the issue is. Any suggestions?

Thanks,

Signature · 1 line
Giovanni
#2 lore raw

Hi,

Quoted 2 lines · Giovanni Cabiddu

On Sat, Jul 09, 2022 at 08:23:35AM +0800, kernel test robot wrote:

...skip...

Quoted 6 lines
Quoted 5 lines
Quoted 1 line
Quoted 1 line

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

vim +24 Documentation/ABI/testing/sysfs-driver-qat

Quoted 1 line

24 Date: June 2022

I'm not able to spot what the issue is. Any suggestions?

Same here. I do not see what issue the test robot is reporting.

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

#3 lore raw

PATCH 1/1 crypto: qat - fix indentation in ABI documentation

Quoted 7 lines · Vlad Dronov

Hi,

Quoted 2 lines · Giovanni Cabiddu

On Sat, Jul 09, 2022 at 08:23:35AM +0800, kernel test robot wrote:

...skip...

Quoted 8 lines
Quoted 6 lines
Quoted 5 lines
Quoted 1 line
Quoted 1 line

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

vim +24 Documentation/ABI/testing/sysfs-driver-qat

Quoted 1 line

24 Date: June 2022

I'm not able to spot what the issue is. Any suggestions?

Same here. I do not see what issue the test robot is reporting.

I found what the issue is. It seems Sphinx doesn't like the extra indentation in the sections.

----8<----

From: Giovanni Cabiddu <[email protected]>
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")
---
 Documentation/ABI/testing/sysfs-driver-qat | 38 ++++++++++------------
 1 file changed, 17 insertions(+), 21 deletions(-)
Documentation/ABI/testing/sysfs-driver-qat +17 -21
index a600531e9562..741d97fa5ae1 100644
@@ -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.
Signature · 1 line
2.36.1
#4 lore raw

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

Quoted 10 lines · Giovanni Cabiddu
Quoted 9 lines · Vlad Dronov

Hi,

Quoted 2 lines · Giovanni Cabiddu

On Sat, Jul 09, 2022 at 08:23:35AM +0800, kernel test robot wrote:

...skip...

Quoted 2 lines
Quoted 2 lines
Quoted 1 line
Quoted 1 line

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

Quoted 8 lines
Quoted 6 lines
Quoted 4 lines
Quoted 3 lines

vim +24 Documentation/ABI/testing/sysfs-driver-qat

Quoted 1 line

24 Date: June 2022

I'm not able to spot what the issue is. Any suggestions?

Same here. I do not see what issue the test robot is reporting.

I found what the issue is. It seems Sphinx doesn't like the extra indentation in the sections.

Resending including linux-crypto. Apologies for the duplicate.

----8<----

From: Giovanni Cabiddu <[email protected]>
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")
---
 Documentation/ABI/testing/sysfs-driver-qat | 38 ++++++++++------------
 1 file changed, 17 insertions(+), 21 deletions(-)
Documentation/ABI/testing/sysfs-driver-qat +17 -21
index a600531e9562..741d97fa5ae1 100644
@@ -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.
Signature · 1 line
2.36.1
#5 lore raw

PATCH RESEND 1/1 crypto: qat - fix indentation in ABI documentation

Quoted 1 line · Giovanni Cabiddu

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 <[email protected]>
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")
---
 Documentation/ABI/testing/sysfs-driver-qat | 38 ++++++++++------------
 1 file changed, 17 insertions(+), 21 deletions(-)
Documentation/ABI/testing/sysfs-driver-qat +17 -21
index a600531e9562..741d97fa5ae1 100644
@@ -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.
Signature · 1 line
2.36.1
#6 lore raw

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

Quoted 14 lines · Giovanni Cabiddu
Documentation/ABI/testing/sysfs-driver-qat +1 -9
@@ -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

Documentation/ABI/testing/sysfs-driver-qat Description: Reports the current configuration of the QAT device and allows · line 56

Quoted 10 lines
Documentation/ABI/testing/sysfs-driver-qat +8 -0
+		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.

Signature · 1 line
An old man doll... just what I always wanted! - Clara
#7 lore raw

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

Hi Bagas,

Quoted 4 lines · Bagas Sanjaya

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,

Signature · 1 line
Giovanni