From: Giovanni Cabiddu <[email protected]>
To: [email protected], Vlad Dronov <[email protected]>,
Herbert Xu <[email protected]>
Cc: [email protected],
GNU/Weeb Mailing List <[email protected]>,
LKML <[email protected]>,
Tomasz Kowallik <[email protected]>,
Adam Guerin <[email protected]>,
Fiona Trahe <[email protected]>,
Wojciech Ziemba <[email protected]>,
[email protected]
Subject: [PATCH] crypto: qat - fix indentation in ABI documentation
Date: Mon, 11 Jul 2022 17:05:01 +0100 [thread overview]
Message-ID: <YsxJnq32lAJIRSET@silpixa00400314> (raw)
In-Reply-To: <CAMusb+QfUZwq+JRkUrOLGO7mQLZbg_ueFVo2_PTSiSRiq7BoEA@mail.gmail.com>
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
next prev parent reply other threads:[~2022-07-11 16:05 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
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 ` Giovanni Cabiddu [this message]
2022-07-11 16:29 ` [PATCH RESEND] crypto: qat - fix indentation in ABI documentation Giovanni Cabiddu
2022-07-11 18:01 ` Giovanni Cabiddu
2022-07-12 10:33 ` Bagas Sanjaya
2022-07-12 11:36 ` Giovanni Cabiddu
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=YsxJnq32lAJIRSET@silpixa00400314 \
[email protected] \
[email protected] \
[email protected] \
[email protected] \
[email protected] \
[email protected] \
[email protected] \
[email protected] \
[email protected] \
[email protected] \
[email protected] \
[email protected] \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox