Re: [PATCH v5 2/2] scsi: leapraid: Add driver documentation

[sashiko-bot@kernel.org]

Thank you for your contribution! Sashiko AI review found 2 potential issue(s) to consider:
- [Medium] The driver introduces a non-standard sysfs attribute `ncq_cmd_prio_enable` for NCQ priority configuration, causing ABI fragmentation.
- [Low] Missing required blank lines after section title underlines in reStructuredText documentation.
--

--- Patch [2]: [PATCH v5 2/2] scsi: leapraid: Add driver documentation ---
commit 630ad4ee0c14f18c620eec6823a389cf9f5654aa
Author: Dongdong Hao <doubled@leap-io-kernel.com>

scsi: leapraid: Add driver documentation

This patch adds the necessary documentation for the LeapRAID SCSI driver
to the kernel's documentation tree.

> diff --git a/Documentation/scsi/leapraid.rst b/Documentation/scsi/leapraid.rst
> new file mode 100644
> index 0000000000000..99930ce2b8d04
> --- /dev/null
> +++ b/Documentation/scsi/leapraid.rst
> @@ -0,0 +1,110 @@

[ ... ]

> +Supported devices
> +=================
> +
> +- LeapHBA-8200C
> +
> +Features
> +========

[Severity: Low]
Are we missing a blank line here?

In reStructuredText, a section title's underline needs to be followed by a
blank line. Failing to provide this blank line causes Sphinx documentation
build warnings.

> +- PCIe Gen4 x8 host interface
> +- Support for SAS and SATA devices

[ ... ]

> +LeapRAID specific disk attributes
> +=================================
> +
> +::
> +
> +   /sys/class/scsi_disk/host:bus:target:lun/device/sas_device_handle
> +   /sys/class/scsi_disk/host:bus:target:lun/device/ncq_cmd_prio_enable

[Severity: Medium]
Does this driver introduce a non-standard sysfs attribute for NCQ priority
configuration?

Using ncq_cmd_prio_enable instead of the standard sas_ncq_prio_enable or
ncq_prio_enable defined in Documentation/ABI/testing/sysfs-block-device can
break userspace compatibility. When a user attempts to configure NCQ priority
via sysfs using generic scripts or udev rules, it might fail for this driver.

> +
> +The read-only attribute "sas_device_handle" represents the disk's device
> +handle, which is a unique identifier maintained by the firmware.

[ ... ]

> +4. poll_queues
> +--------------
> +
> +This parameter specifies the number of I/O queues to be used when operating
> +in io_uring poll mode. The default value is 0.
> +
> +File Location
> +=============

[Severity: Low]
Is a blank line missing after this section underline as well?

> +The driver source is located at:
> +
> +``drivers/scsi/leapraid/``

[ ... ]

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/cover.1785823793.git.doubled@leap-io-kernel.com?part=2