All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jonathan Cameron <jic23@kernel.org>
To: linux-iio@vger.kernel.org, Mugil Raj <dmugil2000@gmail.com>,
	Utkarsh Verma <utkarshverma294@gmail.com>
Subject: iio: TODO Clean up W=1 warnings in staging drivers.
Date: Sun, 14 Mar 2021 16:51:22 +0000	[thread overview]
Message-ID: <20210314165122.2ac5a72a@archlinux> (raw)

Hi All,

Given we've had a few requests recently for useful tasks in IIO I thought I'd
post the bits I'm not touching in a clean up series today.

If you build the kernel with W=1 it will run kernel-doc tests on all the
files.   That tends to show up places where the docs are in some sense not
compliant with the kernel-doc format. See
Documentation/doc-guide/kernel-doc.rst

I'm cleaning up a few that have sneaked into the drivers and core outside

https://lore.kernel.org/linux-iio/20210314164655.408461-1-jic23@kernel.org/T/#t

However, I haven't done the staging drivers

drivers/staging/iio/frequency/ad9832.c:119: warning: Function parameter or member 'lock' not described in 'ad9832_state'
drivers/staging/iio/frequency/ad9832.c:255: warning: Function parameter or member '0200' not described in 'IIO_DEV_ATTR_FREQ'
drivers/staging/iio/frequency/ad9832.c:255: warning: Function parameter or member 'NULL' not described in 'IIO_DEV_ATTR_FREQ'
drivers/staging/iio/frequency/ad9832.c:255: warning: Function parameter or member 'ad9832_write' not described in 'IIO_DEV_ATTR_FREQ'
drivers/staging/iio/frequency/ad9832.c:255: warning: Function parameter or member 'AD9832_FREQ0HM' not described in 'IIO_DEV_ATTR_FREQ'
drivers/staging/iio/frequency/ad9832.c:255: warning: expecting prototype for h for further information(). Prototype was for IIO_DEV_ATTR_FREQ() instead
  CHECK   drivers/staging/iio/meter/ade7854-i2c.c
drivers/staging/iio/frequency/ad9834.c:87: warning: Function parameter or member 'devid' not described in 'ad9834_state'
drivers/staging/iio/frequency/ad9834.c:93: warning: cannot understand function prototype: 'enum ad9834_supported_device_ids '
drivers/staging/iio/frequency/ad9834.c:323: warning: Function parameter or member '0200' not described in 'IIO_DEV_ATTR_FREQ'
drivers/staging/iio/frequency/ad9834.c:323: warning: Function parameter or member 'NULL' not described in 'IIO_DEV_ATTR_FREQ'
drivers/staging/iio/frequency/ad9834.c:323: warning: Function parameter or member 'ad9834_write' not described in 'IIO_DEV_ATTR_FREQ'
drivers/staging/iio/frequency/ad9834.c:323: warning: Function parameter or member 'AD9834_REG_FREQ0' not described in 'IIO_DEV_ATTR_FREQ'
drivers/staging/iio/frequency/ad9834.c:323: warning: expecting prototype for h for further information(). Prototype was for IIO_DEV_ATTR_FREQ() instead

I've not even glanced at the code, so it will be a case of figuring
out what needs fixing :)

Thanks,

Jonathan

                 reply	other threads:[~2021-03-14 16:52 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210314165122.2ac5a72a@archlinux \
    --to=jic23@kernel.org \
    --cc=dmugil2000@gmail.com \
    --cc=linux-iio@vger.kernel.org \
    --cc=utkarshverma294@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.