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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Mon, 11 Jul 2022 17:29:39 +0100
From:   Giovanni Cabiddu <giovanni.cabiddu@...el.com>
To:     lkp@...el.com, Vlad Dronov <vdronov@...hat.com>,
        Herbert Xu <herbert@...dor.apana.org.au>
Cc:     kbuild-all@...ts.01.org,
        GNU/Weeb Mailing List <gwml@...r.gnuweeb.org>,
        LKML <linux-kernel@...r.kernel.org>,
        Tomasz Kowallik <tomaszx.kowalik@...el.com>,
        Adam Guerin <adam.guerin@...el.com>,
        Fiona Trahe <fiona.trahe@...el.com>,
        Wojciech Ziemba <wojciech.ziemba@...el.com>,
        linux-doc@...r.kernel.org, linux-crypto@...r.kernel.org
Subject: Re: [PATCH RESEND] crypto: qat - fix indentation in ABI documentation

On Mon, Jul 11, 2022 at 05:05:18PM +0100, Giovanni Cabiddu wrote:
> On Mon, Jul 11, 2022 at 02:35:07PM +0200, Vlad Dronov wrote:
> > Hi,
> > 
> > On Mon, Jul 11, 2022 at 11:32 AM Giovanni Cabiddu
> > <giovanni.cabiddu@...el.com> wrote:
> > >
> > > On Sat, Jul 09, 2022 at 08:23:35AM +0800, kernel test robot wrote:
> > ...skip...
> > > > >> Documentation/ABI/testing/sysfs-driver-qat:24: WARNING: Unexpected indentation.
> > > >
> > > > vim +24 Documentation/ABI/testing/sysfs-driver-qat
> > > >
> > > >   > 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 <giovanni.cabiddu@...el.com>
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 <lkp@...el.com>
Signed-off-by: Giovanni Cabiddu <giovanni.cabiddu@...el.com>
---
 Documentation/ABI/testing/sysfs-driver-qat | 38 ++++++++++------------
 1 file changed, 17 insertions(+), 21 deletions(-)

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.
-- 
2.36.1