2023-01-20 12:41:25

by Bagas Sanjaya

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

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/[email protected]/
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(-)

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


2023-01-22 09:41:01

by Oded Gabbay

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

On Fri, Jan 20, 2023 at 2:35 PM Bagas Sanjaya <[email protected]> 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/[email protected]/
> 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(-)
>
> 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: [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
> --
> An old man doll... just what I always wanted! - Clara
>

Reviewed-by: Oded Gabbay <[email protected]>
Thanks!
Applied to my -next tree.
Oded