[PATCH next 0/3] miscellaneous documentation fixes for linux-next

[PATCH next 0/3] miscellaneous documentation fixes for linux-next

[Bagas Sanjaya]

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/cover.1657360984.git.mchehab@kernel.org/

Cc: linux-kernel@vger.kernel.org
Cc: linux-next@vger.kernel.org
Cc: kvm@vger.kernel.org
Cc: linux-crypto@vger.kernel.org
Cc: linux-s390@vger.kernel.org

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

[PATCH next 1/3] Documentation: qat: Use code block for qat sysfs example

[Bagas Sanjaya]

kernel test robot and Stephen Rothwell reported htmldocs warning:

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

The warning isn't caused by Date: field pointed by the warning, but rather
by sysfs example that isn't in literal code block.

Add the code block marker.

Link: https://lore.kernel.org/linux-next/20220711204932.333379b4@canb.auug.org.au/
Link: https://lore.kernel.org/linux-doc/202207090803.TEGI95qw-lkp@intel.com/
Reported-by: kernel test robot <lkp@intel.com>
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Fixes: d4cfb144f60551 ("crypto: qat - expose device config through sysfs for 4xxx")
Cc: Wojciech Ziemba <wojciech.ziemba@intel.com>
Cc: Adam Guerin <adam.guerin@intel.com>
Cc: Fiona Trahe <fiona.trahe@intel.com>
Cc: Giovanni Cabiddu <giovanni.cabiddu@intel.com>
Cc: Herbert Xu <herbert@gondor.apana.org.au>
Cc: Vladis Dronov <vdronov@redhat.com>
Cc: Tomasz Kowallik <tomaszx.kowalik@intel.com>
Cc: linux-crypto@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/ABI/testing/sysfs-driver-qat | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Documentation/ABI/testing/sysfs-driver-qat b/Documentation/ABI/testing/sysfs-driver-qat
index a600531e95628f..43e081ec22cc4a 100644
--- a/Documentation/ABI/testing/sysfs-driver-qat
+++ b/Documentation/ABI/testing/sysfs-driver-qat
@@ -46,7 +46,8 @@ 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:
+		run data compression::
+
 			# cat /sys/bus/pci/devices/<BDF>/qat/state
 			up
 			# cat /sys/bus/pci/devices/<BDF>/qat/cfg_services
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH next 1/3] Documentation: qat: Use code block for qat sysfs example

[Giovanni Cabiddu]

On Tue, Jul 12, 2022 at 04:29:52PM +0700, Bagas Sanjaya wrote:
> kernel test robot and Stephen Rothwell reported htmldocs warning:
> 
> Documentation/ABI/testing/sysfs-driver-qat:24: WARNING: Unexpected indentation.
> 
> The warning isn't caused by Date: field pointed by the warning, but rather
> by sysfs example that isn't in literal code block.
> 
> Add the code block marker.
> 
> Link: https://lore.kernel.org/linux-next/20220711204932.333379b4@canb.auug.org.au/
> Link: https://lore.kernel.org/linux-doc/202207090803.TEGI95qw-lkp@intel.com/
> Reported-by: kernel test robot <lkp@intel.com>
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Fixes: d4cfb144f60551 ("crypto: qat - expose device config through sysfs for 4xxx")
> Cc: Wojciech Ziemba <wojciech.ziemba@intel.com>
> Cc: Adam Guerin <adam.guerin@intel.com>
> Cc: Fiona Trahe <fiona.trahe@intel.com>
> Cc: Giovanni Cabiddu <giovanni.cabiddu@intel.com>
> Cc: Herbert Xu <herbert@gondor.apana.org.au>
> Cc: Vladis Dronov <vdronov@redhat.com>
> Cc: Tomasz Kowallik <tomaszx.kowalik@intel.com>
> Cc: linux-crypto@vger.kernel.org
> Cc: linux-kernel@vger.kernel.org
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Acked-by: Giovanni Cabiddu <giovanni.cabiddu@intel.com>

-- 
Giovanni

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

[Bagas Sanjaya]

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

Cc: Adam Guerin <adam.guerin@intel.com>
Cc: Tomasz Kowallik <tomaszx.kowalik@intel.com>
Cc: Giovanni Cabiddu <giovanni.cabiddu@intel.com>
Cc: Wojciech Ziemba <wojciech.ziemba@intel.com>
Cc: Fiona Trahe <fiona.trahe@intel.com>
Cc: linux-crypto@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 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:	qat-linux@intel.com
-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:	qat-linux@intel.com
-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

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

[Giovanni Cabiddu]

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 <adam.guerin@intel.com>
> Cc: Tomasz Kowallik <tomaszx.kowalik@intel.com>
> Cc: Giovanni Cabiddu <giovanni.cabiddu@intel.com>
> Cc: Wojciech Ziemba <wojciech.ziemba@intel.com>
> Cc: Fiona Trahe <fiona.trahe@intel.com>
> Cc: linux-crypto@vger.kernel.org
> Cc: linux-kernel@vger.kernel.org
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Acked-by: Giovanni Cabiddu <giovanni.cabiddu@intel.com>

-- 
Giovanni

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

[Giovanni Cabiddu]

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 <adam.guerin@intel.com>
> Cc: Tomasz Kowallik <tomaszx.kowalik@intel.com>
> Cc: Giovanni Cabiddu <giovanni.cabiddu@intel.com>
> Cc: Wojciech Ziemba <wojciech.ziemba@intel.com>
> Cc: Fiona Trahe <fiona.trahe@intel.com>
> Cc: linux-crypto@vger.kernel.org
> Cc: linux-kernel@vger.kernel.org
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>  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:	qat-linux@intel.com
> -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

[PATCH next 3/3] Documentation: kvm: extend KVM_S390_ZPCI_OP subheading underline

[Bagas Sanjaya]

Stephen Rothwell reported the htmldocs warning:

Documentation/virt/kvm/api.rst:5959: WARNING: Title underline too short.

4.137 KVM_S390_ZPCI_OP
--------------------

The warning is due to subheading underline on KVM_S390_ZPCI_OP section is
short of 2 dashes.

Extend the underline to fix the warning.

Link: https://lore.kernel.org/linux-next/20220711205557.183c3b14@canb.auug.org.au/
Fixes: a0c4d1109d6cc5 ("KVM: s390: add KVM_S390_ZPCI_OP to manage guest zPCI devices")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Cc: Paolo Bonzini <pbonzini@redhat.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Pierre Morel <pmorel@linux.ibm.com>
Cc: Thomas Huth <thuth@redhat.com>
Cc: Matthew Rosato <mjrosato@linux.ibm.com>
Cc: Christian Borntraeger <borntraeger@de.ibm.com>
Cc: Janosch Frank <frankja@linux.ibm.com>
Cc: kvm@vger.kernel.org
Cc: linux-s390@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/virt/kvm/api.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
index 1ae3508d51c537..e6bd6c6dbd13ec 100644
--- a/Documentation/virt/kvm/api.rst
+++ b/Documentation/virt/kvm/api.rst
@@ -5956,7 +5956,7 @@ KVM_PV_DUMP_CPU
   The length of the returned data is provided by uv_info.guest_cpu_stor_len.
 
 4.137 KVM_S390_ZPCI_OP
---------------------
+----------------------
 
 :Capability: KVM_CAP_S390_ZPCI_OP
 :Architectures: s390
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH next 3/3] Documentation: kvm: extend KVM_S390_ZPCI_OP subheading underline

[Christian Borntraeger]

Am 12.07.22 um 11:29 schrieb Bagas Sanjaya:
> Stephen Rothwell reported the htmldocs warning:
> 
> Documentation/virt/kvm/api.rst:5959: WARNING: Title underline too short.
> 
> 4.137 KVM_S390_ZPCI_OP
> --------------------
> 
> The warning is due to subheading underline on KVM_S390_ZPCI_OP section is
> short of 2 dashes.
> 
> Extend the underline to fix the warning.
> 
> Link: https://lore.kernel.org/linux-next/20220711205557.183c3b14@canb.auug.org.au/
> Fixes: a0c4d1109d6cc5 ("KVM: s390: add KVM_S390_ZPCI_OP to manage guest zPCI devices")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Cc: Paolo Bonzini <pbonzini@redhat.com>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: Pierre Morel <pmorel@linux.ibm.com>
> Cc: Thomas Huth <thuth@redhat.com>
> Cc: Matthew Rosato <mjrosato@linux.ibm.com>
> Cc: Christian Borntraeger <borntraeger@de.ibm.com>
> Cc: Janosch Frank <frankja@linux.ibm.com>
> Cc: kvm@vger.kernel.org
> Cc: linux-s390@vger.kernel.org
> Cc: linux-kernel@vger.kernel.org
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

will queue this on top of the kvms390 tree.

> ---
>   Documentation/virt/kvm/api.rst | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
> index 1ae3508d51c537..e6bd6c6dbd13ec 100644
> --- a/Documentation/virt/kvm/api.rst
> +++ b/Documentation/virt/kvm/api.rst
> @@ -5956,7 +5956,7 @@ KVM_PV_DUMP_CPU
>     The length of the returned data is provided by uv_info.guest_cpu_stor_len.
>   
>   4.137 KVM_S390_ZPCI_OP
> ---------------------
> +----------------------
>   
>   :Capability: KVM_CAP_S390_ZPCI_OP
>   :Architectures: s390