2023-12-23 05:07:26

by Randy Dunlap

Subject: [PATCH] iio: linux/iio.h: fix Excess kernel-doc description warning

Remove the @of_xlate: lines to prevent the kernel-doc warning:

include/linux/iio/iio.h:534: warning: Excess struct member 'of_xlate' description in 'iio_info'

Signed-off-by: Randy Dunlap <[email protected]>
Cc: Jonathan Cameron <[email protected]>
Cc: Lars-Peter Clausen <[email protected]>
Cc: [email protected]
---
include/linux/iio/iio.h | 6 ------
1 file changed, 6 deletions(-)

diff -- a/include/linux/iio/iio.h b/include/linux/iio/iio.h
--- a/include/linux/iio/iio.h
+++ b/include/linux/iio/iio.h
@@ -434,13 +434,7 @@ struct iio_trigger; /* forward declarati
* @update_scan_mode: function to configure device and scan buffer when
* channels have changed
* @debugfs_reg_access: function to read or write register value of device
- * @of_xlate: function pointer to obtain channel specifier index.
- * When #iio-cells is greater than '0', the driver could
- * provide a custom of_xlate function that reads the
- * *args* and returns the appropriate index in registered
- * IIO channels array.
* @fwnode_xlate: fwnode based function pointer to obtain channel specifier index.
- * Functionally the same as @of_xlate.
* @hwfifo_set_watermark: function pointer to set the current hardware
* fifo watermark level; see hwfifo_* entries in
* Documentation/ABI/testing/sysfs-bus-iio for details on

2023-12-26 16:03:28

by Jonathan Cameron

Subject: Re: [PATCH] iio: linux/iio.h: fix Excess kernel-doc description warning

On Fri, 22 Dec 2023 21:05:56 -0800
Randy Dunlap <[email protected]> wrote:

> Remove the @of_xlate: lines to prevent the kernel-doc warning:
>
> include/linux/iio/iio.h:534: warning: Excess struct member 'of_xlate' description in 'iio_info'
>
> Signed-off-by: Randy Dunlap <[email protected]>
> Cc: Jonathan Cameron <[email protected]>
> Cc: Lars-Peter Clausen <[email protected]>
> Cc: [email protected]
Applied.

Thanks,

Jonathan

> ---
> include/linux/iio/iio.h | 6 ------
> 1 file changed, 6 deletions(-)
>
> diff -- a/include/linux/iio/iio.h b/include/linux/iio/iio.h
> --- a/include/linux/iio/iio.h
> +++ b/include/linux/iio/iio.h
> @@ -434,13 +434,7 @@ struct iio_trigger; /* forward declarati
> * @update_scan_mode: function to configure device and scan buffer when
> * channels have changed
> * @debugfs_reg_access: function to read or write register value of device
> - * @of_xlate: function pointer to obtain channel specifier index.
> - * When #iio-cells is greater than '0', the driver could
> - * provide a custom of_xlate function that reads the
> - * *args* and returns the appropriate index in registered
> - * IIO channels array.
> * @fwnode_xlate: fwnode based function pointer to obtain channel specifier index.
> - * Functionally the same as @of_xlate.
> * @hwfifo_set_watermark: function pointer to set the current hardware
> * fifo watermark level; see hwfifo_* entries in
> * Documentation/ABI/testing/sysfs-bus-iio for details on