Documentation fixes for linux-next (Jan 20)
Subsystems (5)
cover Documentation fixes for linux-next (Jan 20)
Here are fixes for recent htmldocs warnings reported in linux-next. Each patches can be picked up separately if ACKed.
Bagas Sanjaya (3):
Documentation: accel: escape wildcard in special file path
habanalabs: Fix list of /sys/class/habanalabs/hl<n>/status
kvm: x86/pmu: Add blank line separator before
KVM_CAP_PMU_EVENT_MASKED_EVENTS code path list
.../ABI/testing/sysfs-driver-habanalabs | 23 ++++++++++--------- Documentation/accel/introduction.rst | 6 ++--- Documentation/virt/kvm/api.rst | 1 + 3 files changed, 16 insertions(+), 14 deletions(-)
base-commit: d514392f17fd4d386cfadde7f849d97db4ca1fb0
Signature · 1 line
An old man doll... just what I always wanted! - Clara
PATCH 1/3 Documentation: accel: escape wildcard in special file path
Stephen Rothwell reported htmldocs warning then merging accel tree:
Documentation/accel/introduction.rst:72: WARNING: Inline emphasis start-string without end-string.
Sphinx confuses the file wildcards with inline emphasis (italics), hence the warning.
Fix the warning by escaping wildcards.
--- Documentation/accel/introduction.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
Documentation/accel/introduction.rst +3 -3
@@ -67,9 +67,9 @@ tree - drivers/accel/. The accelerator devices will be exposed to the user space with the dedicated 261 major number and will have the following convention: -- device char files - /dev/accel/accel* -- sysfs - /sys/class/accel/accel*/ -- debugfs - /sys/kernel/debug/accel/*/ +- device char files - /dev/accel/accel\* +- sysfs - /sys/class/accel/accel\*/ +- debugfs - /sys/kernel/debug/accel/\*/ Getting Started ===============
Signature · 1 line
An old man doll... just what I always wanted! - Clara
Re: [PATCH linux-next 1/3] Documentation: accel: escape wildcard in special file path
Quoted 7 lines · Bagas Sanjaya
Stephen Rothwell reported htmldocs warning then merging accel tree:
Documentation/accel/introduction.rst:72: WARNING: Inline emphasis start-string without end-string.Sphinx confuses the file wildcards with inline emphasis (italics), hence the warning.
Quoted 6 lines
Fix the warning by escaping wildcards.
Fixes f65c5dac207322 ("docs: accel: Fix debugfs path")Reported-by Stephen Rothwell <[email protected]>Signed-off-by Bagas Sanjaya <[email protected]>
Thanks for addressing this before I even saw the warning report.
Oded Gabbay
maintainerRe: [PATCH linux-next 1/3] Documentation: accel: escape wildcard in special file path
Quoted 11 lines · Jeffrey Hugo
Quoted 9 lines · Bagas Sanjaya
Stephen Rothwell reported htmldocs warning then merging accel tree:
Documentation/accel/introduction.rst:72: WARNING: Inline emphasis start-string without end-string.Sphinx confuses the file wildcards with inline emphasis (italics), hence the warning.
Fix the warning by escaping wildcards.
Quoted 8 lines
Quoted 4 lines
Fixes f65c5dac207322 ("docs: accel: Fix debugfs path")Reported-by Stephen Rothwell <[email protected]>Signed-off-by Bagas Sanjaya <[email protected]>Thanks for addressing this before I even saw the warning report.
Reviewed-by Jeffrey Hugo <[email protected]>
Thanks.
Picked up to my tree (as the original commit is in my tree). Oded
PATCH 2/3 habanalabs: Fix list of /sys/class/habanalabs/hl<n>/status
In reply to Bagas SanjayaStephen Rothwell reported htmldocs warnings when merging accel tree:
Documentation/ABI/testing/sysfs-driver-habanalabs:201: ERROR: Unexpected indentation. Documentation/ABI/testing/sysfs-driver-habanalabs:201: WARNING: Block quote ends without a blank line; unexpected unindent. Documentation/ABI/testing/sysfs-driver-habanalabs:201: ERROR: Unexpected indentation. Documentation/ABI/testing/sysfs-driver-habanalabs:201: WARNING: Block quote ends without a blank line; unexpected unindent.
Fix these by fixing alignment of list of card status returned by /sys/class/habanalabs/hl<n>/status.
--- .../ABI/testing/sysfs-driver-habanalabs | 23 ++++++++++--------- 1 file changed, 12 insertions(+), 11 deletions(-)
Documentation/ABI/testing/sysfs-driver-habanalabs +12 -11
@@ -202,17 +202,18 @@ Date: Jan 2019 KernelVersion: 5.1 Contact: [email protected] Description: Status of the card: - "operational" - Device is available for work. - "in reset" - Device is going through reset, will be available - shortly. - "disabled" - Device is not usable. - "needs reset" - Device is not usable until a hard reset will - be initiated. - "in device creation" - Device is not available yet, as it is - still initializing. - "in reset after device release" - Device is going through - a compute-reset which is executed after a device release - (relevant for Gaudi2 only). + + * "operational" - Device is available for work. + * "in reset" - Device is going through reset, will be + available shortly. + * "disabled" - Device is not usable. + * "needs reset" - Device is not usable until a hard reset + is initiated. + * "in device creation" - Device is not available yet, as it + is still initializing. + * "in reset after device release" - Device is going through + a compute-reset which is executed after a device release + (relevant for Gaudi2 only). What: /sys/class/habanalabs/hl<n>/thermal_ver Date: Jan 2019
Signature · 1 line
An old man doll... just what I always wanted! - Clara
Re: [PATCH linux-next 2/3] habanalabs: Fix list of /sys/class/habanalabs/hl<n>/status
Quoted 54 lines · Bagas Sanjaya
Stephen Rothwell reported htmldocs warnings when merging accel tree:
Documentation/ABI/testing/sysfs-driver-habanalabs:201: ERROR: Unexpected indentation.Documentation/ABI/testing/sysfs-driver-habanalabs:201: WARNING: Block quote ends without a blank line; unexpected unindent.Documentation/ABI/testing/sysfs-driver-habanalabs:201: ERROR: Unexpected indentation.Documentation/ABI/testing/sysfs-driver-habanalabs:201: WARNING: Block quote ends without a blank line; unexpected unindent.Fix these by fixing alignment of list of card status returned by /sys/class/habanalabs/hl<n>/status.
Fixes 0a14c331682f61 ("habanalabs: update device status sysfs documentation")Reported-by Stephen Rothwell <[email protected]>Signed-off-by Bagas Sanjaya <[email protected]>--- .../ABI/testing/sysfs-driver-habanalabs | 23 ++++++++++--------- 1 file changed, 12 insertions(+), 11 deletions(-)Documentation/ABI/testing/sysfs-driver-habanalabs +12
-12@@ -202,17 +202,18 @@ Date: Jan 2019 KernelVersion: 5.1 Contact: [email protected] Description: Status of the card: - "operational" - Device is available for work. - "in reset" - Device is going through reset, will be available - shortly. - "disabled" - Device is not usable. - "needs reset" - Device is not usable until a hard reset will - be initiated. - "in device creation" - Device is not available yet, as it is - still initializing. - "in reset after device release" - Device is going through - a compute-reset which is executed after a device release - (relevant for Gaudi2 only). + + * "operational" - Device is available for work. + * "in reset" - Device is going through reset, will be + available shortly. + * "disabled" - Device is not usable. + * "needs reset" - Device is not usable until a hard reset + is initiated. + * "in device creation" - Device is not available yet, as it + is still initializing. + * "in reset after device release" - Device is going through + a compute-reset which is executed after a device release + (relevant for Gaudi2 only). What: /sys/class/habanalabs/hl<n>/thermal_ver Date: Jan 2019 --
Quoted 2 lines
An old man doll... just what I always wanted! - Clara
Thanks!
Applied to my -next tree.
Oded
PATCH 3/3 kvm: x86/pmu: Add blank line separator before KVM_CAP_PMU_EVENT_MASKED_EVENTS code path list
In reply to Bagas SanjayaStephen Rothwell reported htmldocs warning when merging kvm-x86 tree:
Documentation/virt/kvm/api.rst:5070: ERROR: Unexpected indentation.
Fix the warning by adding a blank line separator before KVM_CAP_PMU_EVENT_MASKED_EVENTS code path list to determine guest access.
--- Documentation/virt/kvm/api.rst | 1 + 1 file changed, 1 insertion(+)
Documentation/virt/kvm/api.rst +1 -0
@@ -5067,6 +5067,7 @@ An encoded event will follow this layout:: When the guest attempts to program the PMU, these steps are followed in determining if the guest should have access: + 1. Match the event select from the guest against the filter events. 2. If a match is found, match the guest's unit mask to the mask and match values of the included filter events.
Signature · 1 line
An old man doll... just what I always wanted! - Clara
Sean Christopherson
reviewerRe: [PATCH linux-next 3/3] kvm: x86/pmu: Add blank line separator before KVM_CAP_PMU_EVENT_MASKED_EVENTS code path list
Quoted 21 lines · Bagas Sanjaya
Stephen Rothwell reported htmldocs warning when merging kvm-x86 tree:
Documentation/virt/kvm/api.rst:5070: ERROR: Unexpected indentation.Fix the warning by adding a blank line separator before
KVM_CAP_PMU_EVENT_MASKED_EVENTScode path list to determine guest access.Fixes 651daa44b11c0e ("kvm: x86/pmu: Introduce masked events to the pmu event filter")Reported-by Stephen Rothwell <[email protected]>Signed-off-by Bagas Sanjaya <[email protected]>--- Documentation/virt/kvm/api.rst | 1 + 1 file changed, 1 insertion(+)Documentation/virt/kvm/api.rst +0
-0
Documentation/virt/kvm/api.rst An encoded event will follow this layout:: · line 5073
Quoted 7 lines
Documentation/virt/kvm/api.rst +1
-0@@ -5067,6 +5067,7 @@ An encoded event will follow this layout:: When the guest attempts to program the PMU, these steps are followed in determining if the guest should have access: + 1. Match the event select from the guest against the filter events. 2. If a match is found, match the guest's unit mask to the mask and match values of the included filter events.
Squashed this into the offending commit, thanks!