Skip to contentSkip to conversation

miscellaneous documentation fixes for linux-next

PATCH In review Bagas Sanjaya 3 participants 8 messages Jul 12, 2022

Subsystems (5)
lore
Share & tools
lore
#0 lore raw

cover 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]/

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(-)
Signature · 1 line
An old man doll... just what I always wanted! - Clara
#1 lore raw

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

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.

Fixes d4cfb144f60551 ("crypto: qat - expose device config through sysfs for 4xxx")
Cc Wojciech Ziemba <[email protected]>
Cc Adam Guerin <[email protected]>
Cc Fiona Trahe <[email protected]>
Cc Giovanni Cabiddu <[email protected]>
Cc Herbert Xu <[email protected]>
Cc Vladis Dronov <[email protected]>
Cc Tomasz Kowallik <[email protected]>
---
 Documentation/ABI/testing/sysfs-driver-qat | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
Documentation/ABI/testing/sysfs-driver-qat +2 -1
index a600531e95628f..43e081ec22cc4a 100644
@@ -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
Signature · 1 line
An old man doll... just what I always wanted! - Clara
Acked-by on v1 1/3
#2 lore raw

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

Quoted 9 lines · 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.

Quoted 15 lines
Fixes d4cfb144f60551 ("crypto: qat - expose device config through sysfs for 4xxx")
Cc Wojciech Ziemba <[email protected]>
Cc Adam Guerin <[email protected]>
Cc Fiona Trahe <[email protected]>
Cc Giovanni Cabiddu <[email protected]>
Cc Herbert Xu <[email protected]>
Cc Vladis Dronov <[email protected]>
Cc Tomasz Kowallik <[email protected]>
Signature · 1 line
Giovanni
#3 lore raw

PATCH 2/3 Documentation: qat: rewrite description

In reply to 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 <[email protected]>
Cc Tomasz Kowallik <[email protected]>
Cc Giovanni Cabiddu <[email protected]>
Cc Wojciech Ziemba <[email protected]>
Cc Fiona Trahe <[email protected]>
---
 Documentation/ABI/testing/sysfs-driver-qat | 34 +++++++---------------
 1 file changed, 11 insertions(+), 23 deletions(-)
Documentation/ABI/testing/sysfs-driver-qat +11 -23
index 43e081ec22cc4a..be6c200abd783c 100644
@@ -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)
Signature · 1 line
An old man doll... just what I always wanted! - Clara
Acked-by on v1 2/3
#4 lore raw

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

Quoted 11 lines · 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 <[email protected]>
Cc Tomasz Kowallik <[email protected]>
Cc Giovanni Cabiddu <[email protected]>
Cc Wojciech Ziemba <[email protected]>
Cc Fiona Trahe <[email protected]>
Signature · 1 line
Giovanni
#5 lore raw

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

In reply to Bagas Sanjaya
Quoted 20 lines · 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 <[email protected]>
Cc Tomasz Kowallik <[email protected]>
Cc Giovanni Cabiddu <[email protected]>
Cc Wojciech Ziemba <[email protected]>
Cc Fiona Trahe <[email protected]>
---
 Documentation/ABI/testing/sysfs-driver-qat | 34 +++++++---------------
 1 file changed, 11 insertions(+), 23 deletions(-)
Documentation/ABI/testing/sysfs-driver-qat +0 -0
index 43e081ec22cc4a..be6c200abd783c 100644

Documentation/ABI/testing/sysfs-driver-qat What: /sys/bus/pci/devices/<BDF>/qat/state · line 6

Quoted 7 lines
Documentation/ABI/testing/sysfs-driver-qat +2 -2
@@ -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,

Signature · 1 line
Giovanni
#6 lore raw

PATCH 3/3 Documentation: kvm: extend KVM_S390_ZPCI_OP subheading underline

In reply to 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.

Fixes a0c4d1109d6cc5 ("KVM: s390: add KVM_S390_ZPCI_OP to manage guest zPCI devices")
Cc Paolo Bonzini <[email protected]>
Cc Jonathan Corbet <[email protected]>
Cc Pierre Morel <[email protected]>
Cc Thomas Huth <[email protected]>
Cc Matthew Rosato <[email protected]>
Cc Christian Borntraeger <[email protected]>
Cc Janosch Frank <[email protected]>
---
 Documentation/virt/kvm/api.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/virt/kvm/api.rst +1 -1
index 1ae3508d51c537..e6bd6c6dbd13ec 100644
@@ -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
Signature · 1 line
An old man doll... just what I always wanted! - Clara
#7 lore raw

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

Am 12.07.22 um 11:29 schrieb Bagas Sanjaya:

Quoted 12 lines

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.

Quoted 14 lines
Fixes a0c4d1109d6cc5 ("KVM: s390: add KVM_S390_ZPCI_OP to manage guest zPCI devices")
Cc Paolo Bonzini <[email protected]>
Cc Jonathan Corbet <[email protected]>
Cc Pierre Morel <[email protected]>
Cc Thomas Huth <[email protected]>
Cc Matthew Rosato <[email protected]>
Cc Christian Borntraeger <[email protected]>
Cc Janosch Frank <[email protected]>

will queue this on top of the kvms390 tree.

Quoted 17 lines
---
  Documentation/virt/kvm/api.rst | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/virt/kvm/api.rst +1 -1
index 1ae3508d51c537..e6bd6c6dbd13ec 100644
@@ -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