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

Message ID 20230120123534.137413-3-bagasdotme@gmail.com
State New
Headers
Series Documentation fixes for linux-next (Jan 20) |

Commit Message

Bagas Sanjaya Jan. 20, 2023, 12:35 p.m. UTC
  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(-)
  

Comments

Oded Gabbay Jan. 22, 2023, 9:37 a.m. UTC | #1
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
  

Patch

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