* [ammarfaizi2-block:herbert/cryptodev-2.6/master 45/53] htmldocs: Documentation/ABI/testing/sysfs-driver-qat:24: WARNING: Unexpected indentation.
@ 2022-07-09 0:23 kernel test robot
2022-07-11 9:32 ` Giovanni Cabiddu
0 siblings, 1 reply; 8+ messages in thread
From: kernel test robot @ 2022-07-09 0:23 UTC (permalink / raw)
To: Giovanni Cabiddu
Cc: kbuild-all, GNU/Weeb Mailing List, linux-kernel, Herbert Xu,
Tomasz Kowallik, Adam Guerin, Fiona Trahe, Wojciech Ziemba,
Vladis Dronov, linux-doc
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
Reported-by: kernel test robot <[email protected]>
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
--
0-DAY CI Kernel Test Service
https://01.org/lkp
^ permalink raw reply [flat|nested] 8+ messages in thread* Re: [ammarfaizi2-block:herbert/cryptodev-2.6/master 45/53] htmldocs: Documentation/ABI/testing/sysfs-driver-qat:24: WARNING: Unexpected indentation. 2022-07-09 0:23 [ammarfaizi2-block:herbert/cryptodev-2.6/master 45/53] htmldocs: Documentation/ABI/testing/sysfs-driver-qat:24: WARNING: Unexpected indentation kernel test robot @ 2022-07-11 9:32 ` Giovanni Cabiddu 2022-07-11 12:35 ` Vlad Dronov 0 siblings, 1 reply; 8+ messages in thread From: Giovanni Cabiddu @ 2022-07-11 9:32 UTC (permalink / raw) To: kernel test robot Cc: kbuild-all, GNU/Weeb Mailing List, linux-kernel, Herbert Xu, Tomasz Kowallik, Adam Guerin, Fiona Trahe, Wojciech Ziemba, Vladis Dronov, linux-doc On Sat, Jul 09, 2022 at 08:23:35AM +0800, kernel test robot wrote: > 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 > Reported-by: kernel test robot <[email protected]> > > 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 I'm not able to spot what the issue is. Any suggestions? Thanks, -- Giovanni ^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [ammarfaizi2-block:herbert/cryptodev-2.6/master 45/53] htmldocs: Documentation/ABI/testing/sysfs-driver-qat:24: WARNING: Unexpected indentation. 2022-07-11 9:32 ` Giovanni Cabiddu @ 2022-07-11 12:35 ` Vlad Dronov 2022-07-11 16:05 ` [PATCH] crypto: qat - fix indentation in ABI documentation Giovanni Cabiddu 0 siblings, 1 reply; 8+ messages in thread From: Vlad Dronov @ 2022-07-11 12:35 UTC (permalink / raw) To: Giovanni Cabiddu Cc: kernel test robot, kbuild-all, GNU/Weeb Mailing List, LKML, Herbert Xu, Tomasz Kowallik, Adam Guerin, Fiona Trahe, Wojciech Ziemba, linux-doc Hi, On Mon, Jul 11, 2022 at 11:32 AM Giovanni Cabiddu <[email protected]> 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. Best regards, Vladis Dronov | Red Hat, Inc. | The Core Kernel | Senior Software Engineer ^ permalink raw reply [flat|nested] 8+ messages in thread
* [PATCH] crypto: qat - fix indentation in ABI documentation 2022-07-11 12:35 ` Vlad Dronov @ 2022-07-11 16:05 ` Giovanni Cabiddu 2022-07-11 16:29 ` [PATCH RESEND] " Giovanni Cabiddu 0 siblings, 1 reply; 8+ messages in thread From: Giovanni Cabiddu @ 2022-07-11 16:05 UTC (permalink / raw) To: lkp, Vlad Dronov, Herbert Xu Cc: kbuild-all, GNU/Weeb Mailing List, LKML, Tomasz Kowallik, Adam Guerin, Fiona Trahe, Wojciech Ziemba, linux-doc 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 > <[email protected]> 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. ----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") Reported-by: kernel test robot <[email protected]> Signed-off-by: Giovanni Cabiddu <[email protected]> --- 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 ^ permalink raw reply related [flat|nested] 8+ messages in thread
* Re: [PATCH RESEND] crypto: qat - fix indentation in ABI documentation 2022-07-11 16:05 ` [PATCH] crypto: qat - fix indentation in ABI documentation Giovanni Cabiddu @ 2022-07-11 16:29 ` Giovanni Cabiddu 2022-07-11 18:01 ` Giovanni Cabiddu 0 siblings, 1 reply; 8+ messages in thread From: Giovanni Cabiddu @ 2022-07-11 16:29 UTC (permalink / raw) To: lkp, Vlad Dronov, Herbert Xu Cc: kbuild-all, GNU/Weeb Mailing List, LKML, Tomasz Kowallik, Adam Guerin, Fiona Trahe, Wojciech Ziemba, linux-doc, linux-crypto 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 > > <[email protected]> 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 <[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") Reported-by: kernel test robot <[email protected]> Signed-off-by: Giovanni Cabiddu <[email protected]> --- 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 ^ permalink raw reply related [flat|nested] 8+ messages in thread
* [PATCH RESEND] crypto: qat - fix indentation in ABI documentation 2022-07-11 16:29 ` [PATCH RESEND] " Giovanni Cabiddu @ 2022-07-11 18:01 ` Giovanni Cabiddu 2022-07-12 10:33 ` Bagas Sanjaya 0 siblings, 1 reply; 8+ messages in thread From: Giovanni Cabiddu @ 2022-07-11 18:01 UTC (permalink / raw) To: lkp, Vlad Dronov, Herbert Xu Cc: kbuild-all, GNU/Weeb Mailing List, LKML, Tomasz Kowallik, Adam Guerin, Fiona Trahe, Wojciech Ziemba, linux-doc, linux-crypto 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 <[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") Reported-by: kernel test robot <[email protected]> Signed-off-by: Giovanni Cabiddu <[email protected]> --- 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 ^ permalink raw reply related [flat|nested] 8+ messages in thread
* Re: [PATCH RESEND] crypto: qat - fix indentation in ABI documentation 2022-07-11 18:01 ` Giovanni Cabiddu @ 2022-07-12 10:33 ` Bagas Sanjaya 2022-07-12 11:36 ` Giovanni Cabiddu 0 siblings, 1 reply; 8+ messages in thread From: Bagas Sanjaya @ 2022-07-12 10:33 UTC (permalink / raw) To: Giovanni Cabiddu, lkp, Vlad Dronov, Herbert Xu Cc: kbuild-all, GNU/Weeb Mailing List, LKML, Tomasz Kowallik, Adam Guerin, Fiona Trahe, Wojciech Ziemba, linux-doc, linux-crypto 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. -- An old man doll... just what I always wanted! - Clara ^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [PATCH RESEND] crypto: qat - fix indentation in ABI documentation 2022-07-12 10:33 ` Bagas Sanjaya @ 2022-07-12 11:36 ` Giovanni Cabiddu 0 siblings, 0 replies; 8+ messages in thread From: Giovanni Cabiddu @ 2022-07-12 11:36 UTC (permalink / raw) To: Bagas Sanjaya Cc: lkp, Vlad Dronov, Herbert Xu, kbuild-all, GNU/Weeb Mailing List, LKML, Tomasz Kowallik, Adam Guerin, Fiona Trahe, Wojciech Ziemba, linux-doc, linux-crypto 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, -- Giovanni ^ permalink raw reply [flat|nested] 8+ messages in thread
end of thread, other threads:[~2022-07-12 11:36 UTC | newest] Thread overview: 8+ messages (download: mbox.gz follow: Atom feed -- links below jump to the message on this page -- 2022-07-09 0:23 [ammarfaizi2-block:herbert/cryptodev-2.6/master 45/53] htmldocs: Documentation/ABI/testing/sysfs-driver-qat:24: WARNING: Unexpected indentation kernel test robot 2022-07-11 9:32 ` Giovanni Cabiddu 2022-07-11 12:35 ` Vlad Dronov 2022-07-11 16:05 ` [PATCH] crypto: qat - fix indentation in ABI documentation Giovanni Cabiddu 2022-07-11 16:29 ` [PATCH RESEND] " Giovanni Cabiddu 2022-07-11 18:01 ` Giovanni Cabiddu 2022-07-12 10:33 ` Bagas Sanjaya 2022-07-12 11:36 ` Giovanni Cabiddu
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox