Re: [PATCH v5 2/3] Documentation: add a isolation strategy sysfs node for uacce

From: Greg KH
Date: Fri Jul 08 2022 - 03:30:58 EST


On Fri, Jul 08, 2022 at 03:08:19PM +0800, Kai Ye wrote:
> Update documentation describing sysfs node that could help to
> configure isolation strategy for users in the user space. And
> describing sysfs node that could read the device isolated state.
>
> Signed-off-by: Kai Ye <yekai13@xxxxxxxxxx>
> ---
> Documentation/ABI/testing/sysfs-driver-uacce | 18 ++++++++++++++++++
> 1 file changed, 18 insertions(+)
>
> diff --git a/Documentation/ABI/testing/sysfs-driver-uacce b/Documentation/ABI/testing/sysfs-driver-uacce
> index 08f2591138af..a8056271a963 100644
> --- a/Documentation/ABI/testing/sysfs-driver-uacce
> +++ b/Documentation/ABI/testing/sysfs-driver-uacce
> @@ -19,6 +19,24 @@ Contact: linux-accelerators@xxxxxxxxxxxxxxxx
> Description: Available instances left of the device
> Return -ENODEV if uacce_ops get_available_instances is not provided
>
> +What: /sys/class/uacce/<dev_name>/isolate_strategy
> +Date: Jul 2022
> +KernelVersion: 5.20
> +Contact: linux-accelerators@xxxxxxxxxxxxxxxx
> +Description: A sysfs node that used to configures the hardware error
> + isolation strategy. This strategy is a configured integer value.
> + The default is 0. The maximum value is 65535. This value
> + indicates the number of device slot resets per unit time
> + that your service can tolerate.
> +
> +What: /sys/class/uacce/<dev_name>/isolate
> +Date: Jul 2022
> +KernelVersion: 5.20
> +Contact: linux-accelerators@xxxxxxxxxxxxxxxx
> +Description: A sysfs node that read the device isolated state. The value 0
> + means that the device is working. The value 1 means that the
> + device has been isolated.
> +

You only describe 2 files here, yet your patch had 3 sysfs files.
Please always document everything.

thanks,

greg k-h