[PATCH linux-next 0/3] Documentation fixes for linux-next (Jan 20)

[PATCH linux-next 0/3] Documentation fixes for linux-next (Jan 20)

[Bagas Sanjaya]

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
-- 
An old man doll... just what I always wanted! - Clara

[PATCH linux-next 1/3] Documentation: accel: escape wildcard in special file path

[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.

Link: https://lore.kernel.org/linux-next/20230120132116.21de1104@canb.auug.org.au/
Fixes: f65c5dac207322 ("docs: accel: Fix debugfs path")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/accel/introduction.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/accel/introduction.rst b/Documentation/accel/introduction.rst
index 11cade51f387a6..89984dfececf0b 100644
--- a/Documentation/accel/introduction.rst
+++ b/Documentation/accel/introduction.rst
@@ -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
 ===============
-- 
An old man doll... just what I always wanted! - Clara

[PATCH linux-next 2/3] habanalabs: Fix list of /sys/class/habanalabs/hl<n>/status

[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.

Link: https://lore.kernel.org/linux-next/20230120130634.61c3e857@canb.auug.org.au/
Fixes: 0a14c331682f61 ("habanalabs: update device status sysfs documentation")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 .../ABI/testing/sysfs-driver-habanalabs       | 23 ++++++++++---------
 1 file changed, 12 insertions(+), 11 deletions(-)

diff --git a/Documentation/ABI/testing/sysfs-driver-habanalabs b/Documentation/ABI/testing/sysfs-driver-habanalabs
index df2ca1a401b5a1..1b98b6503b23f5 100644
--- a/Documentation/ABI/testing/sysfs-driver-habanalabs
+++ b/Documentation/ABI/testing/sysfs-driver-habanalabs
@@ -202,17 +202,18 @@ Date:           Jan 2019
 KernelVersion:  5.1
 Contact:        ogabbay@kernel.org
 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
-- 
An old man doll... just what I always wanted! - Clara

[PATCH linux-next 3/3] kvm: x86/pmu: Add blank line separator before KVM_CAP_PMU_EVENT_MASKED_EVENTS code path list

[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_EVENTS code path list to determine guest access.

Link: https://lore.kernel.org/linux-next/20230120130927.3100f935@canb.auug.org.au/
Fixes: 651daa44b11c0e ("kvm: x86/pmu: Introduce masked events to the pmu event filter")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/virt/kvm/api.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
index a477186c57c193..83e3acc9e3211d 100644
--- a/Documentation/virt/kvm/api.rst
+++ b/Documentation/virt/kvm/api.rst
@@ -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.
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH linux-next 1/3] Documentation: accel: escape wildcard in special file path

[Jeffrey Hugo]

On 1/20/2023 5:35 AM, Bagas Sanjaya wrote:
> 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.
> 
> Link: https://lore.kernel.org/linux-next/20230120132116.21de1104@canb.auug.org.au/
> Fixes: f65c5dac207322 ("docs: accel: Fix debugfs path")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

Thanks for addressing this before I even saw the warning report.

Reviewed-by: Jeffrey Hugo <quic_jhugo@quicinc.com>

Re: [PATCH linux-next 3/3] kvm: x86/pmu: Add blank line separator before KVM_CAP_PMU_EVENT_MASKED_EVENTS code path list

[Sean Christopherson]

On Fri, Jan 20, 2023, Bagas Sanjaya wrote:
> 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_EVENTS code path list to determine guest access.
> 
> Link: https://lore.kernel.org/linux-next/20230120130927.3100f935@canb.auug.org.au/
> Fixes: 651daa44b11c0e ("kvm: x86/pmu: Introduce masked events to the pmu event filter")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>  Documentation/virt/kvm/api.rst | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
> index a477186c57c193..83e3acc9e3211d 100644
> --- a/Documentation/virt/kvm/api.rst
> +++ b/Documentation/virt/kvm/api.rst
> @@ -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!

Re: [PATCH linux-next 1/3] Documentation: accel: escape wildcard in special file path

[Oded Gabbay]

On Fri, Jan 20, 2023 at 5:00 PM Jeffrey Hugo <quic_jhugo@quicinc.com> wrote:
>
> On 1/20/2023 5:35 AM, Bagas Sanjaya wrote:
> > 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.
> >
> > Link: https://lore.kernel.org/linux-next/20230120132116.21de1104@canb.auug.org.au/
> > Fixes: f65c5dac207322 ("docs: accel: Fix debugfs path")
> > Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> > Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
>
> Thanks for addressing this before I even saw the warning report.
>
> Reviewed-by: Jeffrey Hugo <quic_jhugo@quicinc.com>
Thanks.
Picked up to my tree (as the original commit is in my tree).
Oded

Re: [PATCH linux-next 2/3] habanalabs: Fix list of /sys/class/habanalabs/hl<n>/status

[Oded Gabbay]

On Fri, Jan 20, 2023 at 2:35 PM Bagas Sanjaya <bagasdotme@gmail.com> wrote:
>
> 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.
>
> Link: https://lore.kernel.org/linux-next/20230120130634.61c3e857@canb.auug.org.au/
> Fixes: 0a14c331682f61 ("habanalabs: update device status sysfs documentation")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>  .../ABI/testing/sysfs-driver-habanalabs       | 23 ++++++++++---------
>  1 file changed, 12 insertions(+), 11 deletions(-)
>
> diff --git a/Documentation/ABI/testing/sysfs-driver-habanalabs b/Documentation/ABI/testing/sysfs-driver-habanalabs
> index df2ca1a401b5a1..1b98b6503b23f5 100644
> --- a/Documentation/ABI/testing/sysfs-driver-habanalabs
> +++ b/Documentation/ABI/testing/sysfs-driver-habanalabs
> @@ -202,17 +202,18 @@ Date:           Jan 2019
>  KernelVersion:  5.1
>  Contact:        ogabbay@kernel.org
>  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
> --
> An old man doll... just what I always wanted! - Clara
>

Reviewed-by: Oded Gabbay <ogabbay@kernel.org>
Thanks!
Applied to my -next tree.
Oded