Re: [PATCH RFC v4 09/10] Documentation: ABI: testing: add docs for ad9910 sysfs entries

[sashiko-bot@kernel.org]

Thank you for your contribution! Sashiko AI review found 2 potential issue(s) to consider:
- [Low] The newly added ABI documentation file omits the `Date:` field and leaves the `KernelVersion:` field empty for all entries.
- [Low] Awkward and confusing phrasing in the descriptions of multiple ABI attributes: 'is a result with the sum of this value'.
--

commit a42d44a5e6db95765e7fc42b4509b02bd033fda8
Author: Rodrigo Alencar <rodrigo.alencar@analog.com>

Documentation: ABI: testing: add docs for ad9910 sysfs entries

This commit adds a custom ABI documentation file for the DDS AD9910 with
sysfs entries to control Parallel Port, Digital Ramp Generator and OSK
parameters.

> diff --git a/Documentation/ABI/testing/sysfs-bus-iio-frequency-ad9910 b/Documentation/ABI/testing/sysfs-bus-iio-frequency-ad9910
> new file mode 100644
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-bus-iio-frequency-ad9910
> @@ -0,0 +1,73 @@
> +What:		/sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency_offset
> +KernelVersion:

This isn't a bug, but the Date field is missing and the KernelVersion field
is empty for this and all subsequent entries in the file. Should these be
populated with the creation date and the expected kernel release?

> +Contact:	linux-iio@vger.kernel.org
> +Description:
> +		For a channel that allows frequency control through buffers, this
> +		represents the base frequency value in Hz. The actual output frequency
> +		is a result with the sum of this value.

This isn't a bug, but the phrasing "is a result with the sum of this value"
is slightly confusing. Would it be clearer to phrase this as "is the sum of
this value and the input value"?

This same phrasing is also used below in the descriptions for
out_altvoltageY_phase_offset and out_altvoltageY_scale_offset.

[ ... ]

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/20260508-ad9910-iio-driver-v4-0-d26bfd20ee3d@analog.com?part=9