diff mbox series

[1/3] iio:imu:adis16400: Sort out missing kernel doc.

Message ID 20200913132115.800131-2-jic23@kernel.org
State New
Headers show
Series IIO get to warning free for W=1 C=1 | expand

Commit Message

Jonathan Cameron Sept. 13, 2020, 1:21 p.m. UTC
From: Jonathan Cameron <Jonathan.Cameron@huawei.com>

I'd like to be enable W=1 for all IIO builds as it catches real issues as well
as more minor documentation issues such as this (also good to fix though!)

drivers/iio/imu/adis16400.c:183: warning: Function parameter or member 'avail_scan_mask' not described in 'adis16400_state'

Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Cc: Alexandru Ardelean <alexandru.ardelean@analog.com>
---
 drivers/iio/imu/adis16400.c | 2 ++
 1 file changed, 2 insertions(+)

Comments

Alexandru Ardelean Sept. 14, 2020, 5:52 a.m. UTC | #1
On Sun, Sep 13, 2020 at 4:24 PM Jonathan Cameron <jic23@kernel.org> wrote:
>
> From: Jonathan Cameron <Jonathan.Cameron@huawei.com>
>
> I'd like to be enable W=1 for all IIO builds as it catches real issues as well
> as more minor documentation issues such as this (also good to fix though!)
>
> drivers/iio/imu/adis16400.c:183: warning: Function parameter or member 'avail_scan_mask' not described in 'adis16400_state'
>

Acked-by: Alexandru Ardelean <alexandru.ardelean@analog.com>

> Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> Cc: Alexandru Ardelean <alexandru.ardelean@analog.com>
> ---
>  drivers/iio/imu/adis16400.c | 2 ++
>  1 file changed, 2 insertions(+)
>
> diff --git a/drivers/iio/imu/adis16400.c b/drivers/iio/imu/adis16400.c
> index 1ebe3e50d3e6..140cfc65ee8c 100644
> --- a/drivers/iio/imu/adis16400.c
> +++ b/drivers/iio/imu/adis16400.c
> @@ -173,6 +173,8 @@ struct adis16400_chip_info {
>   * @variant:   chip variant info
>   * @filt_int:  integer part of requested filter frequency
>   * @adis:      adis device
> + * @avail_scan_mask:   NULL terminated array of bitmaps of channels
> + *                     that must be enabled together
>   **/
>  struct adis16400_state {
>         struct adis16400_chip_info      *variant;
> --
> 2.28.0
>
Jonathan Cameron Sept. 17, 2020, 6:02 p.m. UTC | #2
On Mon, 14 Sep 2020 08:52:34 +0300
Alexandru Ardelean <ardeleanalex@gmail.com> wrote:

> On Sun, Sep 13, 2020 at 4:24 PM Jonathan Cameron <jic23@kernel.org> wrote:
> >
> > From: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> >
> > I'd like to be enable W=1 for all IIO builds as it catches real issues as well
> > as more minor documentation issues such as this (also good to fix though!)
> >
> > drivers/iio/imu/adis16400.c:183: warning: Function parameter or member 'avail_scan_mask' not described in 'adis16400_state'
> >  
> 
> Acked-by: Alexandru Ardelean <alexandru.ardelean@analog.com>
> 
> > Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> > Cc: Alexandru Ardelean <alexandru.ardelean@analog.com>
Applied to the togreg branch of iio.git
Thanks,

Jonathan

> > ---
> >  drivers/iio/imu/adis16400.c | 2 ++
> >  1 file changed, 2 insertions(+)
> >
> > diff --git a/drivers/iio/imu/adis16400.c b/drivers/iio/imu/adis16400.c
> > index 1ebe3e50d3e6..140cfc65ee8c 100644
> > --- a/drivers/iio/imu/adis16400.c
> > +++ b/drivers/iio/imu/adis16400.c
> > @@ -173,6 +173,8 @@ struct adis16400_chip_info {
> >   * @variant:   chip variant info
> >   * @filt_int:  integer part of requested filter frequency
> >   * @adis:      adis device
> > + * @avail_scan_mask:   NULL terminated array of bitmaps of channels
> > + *                     that must be enabled together
> >   **/
> >  struct adis16400_state {
> >         struct adis16400_chip_info      *variant;
> > --
> > 2.28.0
> >
diff mbox series

Patch

diff --git a/drivers/iio/imu/adis16400.c b/drivers/iio/imu/adis16400.c
index 1ebe3e50d3e6..140cfc65ee8c 100644
--- a/drivers/iio/imu/adis16400.c
+++ b/drivers/iio/imu/adis16400.c
@@ -173,6 +173,8 @@  struct adis16400_chip_info {
  * @variant:	chip variant info
  * @filt_int:	integer part of requested filter frequency
  * @adis:	adis device
+ * @avail_scan_mask:	NULL terminated array of bitmaps of channels
+ *			that must be enabled together
  **/
 struct adis16400_state {
 	struct adis16400_chip_info	*variant;