2022-07-12 09:38:34

by Bagas Sanjaya

[permalink] [raw]
Subject: [PATCH next 0/3] miscellaneous documentation fixes for linux-next

Here are documentation fixes for recent warnings reported in linux-next.

This series is based on next-20220611 and Mauro's cross-ref and doc fixes
series [1]:

[1]: https://lore.kernel.org/linux-doc/[email protected]/

Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]

Bagas Sanjaya (3):
Documentation: qat: Use code block for qat sysfs example
Documentation: qat: rewrite description
Documentation: kvm: extend KVM_S390_ZPCI_OP subheading underline

Documentation/ABI/testing/sysfs-driver-qat | 37 ++++++++--------------
Documentation/virt/kvm/api.rst | 2 +-
2 files changed, 14 insertions(+), 25 deletions(-)

--
An old man doll... just what I always wanted! - Clara


2022-07-12 09:38:36

by Bagas Sanjaya

[permalink] [raw]
Subject: [PATCH next 2/3] Documentation: qat: rewrite description

The sysfs description contains redundancy on returned and allowed values
list, due to the described sysfs is read-write. Rewrite.

Cc: Adam Guerin <[email protected]>
Cc: Tomasz Kowallik <[email protected]>
Cc: Giovanni Cabiddu <[email protected]>
Cc: Wojciech Ziemba <[email protected]>
Cc: Fiona Trahe <[email protected]>
Cc: [email protected]
Cc: [email protected]
Signed-off-by: Bagas Sanjaya <[email protected]>
---
Documentation/ABI/testing/sysfs-driver-qat | 34 +++++++---------------
1 file changed, 11 insertions(+), 23 deletions(-)

diff --git a/Documentation/ABI/testing/sysfs-driver-qat b/Documentation/ABI/testing/sysfs-driver-qat
index 43e081ec22cc4a..be6c200abd783c 100644
--- a/Documentation/ABI/testing/sysfs-driver-qat
+++ b/Documentation/ABI/testing/sysfs-driver-qat
@@ -2,18 +2,14 @@ What: /sys/bus/pci/devices/<BDF>/qat/state
Date: June 2022
KernelVersion: 5.20
Contact: [email protected]
-Description: Reports the current state of the QAT device and allows to
- change it.
+Description: (RW) Reports the current state of the QAT device. Write to
+ the file to initalize and start the device or to stop it.

- This attribute is RW.
+ The values are:

- 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

It is possible to transition the device from up to down only
if the device is up and vice versa.
@@ -24,22 +20,14 @@ What: /sys/bus/pci/devices/<BDF>/qat/cfg_services
Date: June 2022
KernelVersion: 5.20
Contact: [email protected]
-Description: Reports the current configuration of the QAT device and allows
- to change it.
+Description: (RW) Reports the current configuration of the QAT device.
+ Write to the file to change the configured services.

- This attribute is RW.
+ The values are:

- Returned values:
- 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: the device is configured for running crypto
+ services
+ * dc: the device is configured 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)
--
An old man doll... just what I always wanted! - Clara

2022-07-12 11:34:13

by Cabiddu, Giovanni

[permalink] [raw]
Subject: Re: [PATCH next 2/3] Documentation: qat: rewrite description

On Tue, Jul 12, 2022 at 04:29:53PM +0700, Bagas Sanjaya wrote:
> The sysfs description contains redundancy on returned and allowed values
> list, due to the described sysfs is read-write. Rewrite.
>
> Cc: Adam Guerin <[email protected]>
> Cc: Tomasz Kowallik <[email protected]>
> Cc: Giovanni Cabiddu <[email protected]>
> Cc: Wojciech Ziemba <[email protected]>
> Cc: Fiona Trahe <[email protected]>
> Cc: [email protected]
> Cc: [email protected]
> Signed-off-by: Bagas Sanjaya <[email protected]>
Acked-by: Giovanni Cabiddu <[email protected]>

--
Giovanni

2022-07-12 21:59:52

by Cabiddu, Giovanni

[permalink] [raw]
Subject: Re: [PATCH next 2/3] Documentation: qat: rewrite description

On Tue, Jul 12, 2022 at 04:29:53PM +0700, Bagas Sanjaya wrote:
> The sysfs description contains redundancy on returned and allowed values
> list, due to the described sysfs is read-write. Rewrite.
>
> Cc: Adam Guerin <[email protected]>
> Cc: Tomasz Kowallik <[email protected]>
> Cc: Giovanni Cabiddu <[email protected]>
> Cc: Wojciech Ziemba <[email protected]>
> Cc: Fiona Trahe <[email protected]>
> Cc: [email protected]
> Cc: [email protected]
> Signed-off-by: Bagas Sanjaya <[email protected]>
> ---
> Documentation/ABI/testing/sysfs-driver-qat | 34 +++++++---------------
> 1 file changed, 11 insertions(+), 23 deletions(-)
>
> diff --git a/Documentation/ABI/testing/sysfs-driver-qat b/Documentation/ABI/testing/sysfs-driver-qat
> index 43e081ec22cc4a..be6c200abd783c 100644
> --- a/Documentation/ABI/testing/sysfs-driver-qat
> +++ b/Documentation/ABI/testing/sysfs-driver-qat
> @@ -2,18 +2,14 @@ What: /sys/bus/pci/devices/<BDF>/qat/state
> Date: June 2022
> KernelVersion: 5.20
> Contact: [email protected]
> -Description: Reports the current state of the QAT device and allows to
> - change it.
> +Description: (RW) Reports the current state of the QAT device. Write to
> + the file to initalize and start the device or to stop it.
^^^^^^^^^
Typo: initalize.
It is possible just to say: "Write to the file to start or stop the
device".

Regards,

--
Giovanni