All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jonathan Cameron <jic23@kernel.org>
To: "Tobin C. Harding" <me@tobin.cc>
Cc: Hartmut Knaack <knaack.h@gmx.de>,
	Lars-Peter Clausen <lars@metafoo.de>,
	Peter Meerwald-Stadler <pmeerw@pmeerw.net>,
	linux-iio@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] iio: fix SPHINX kernel-docs build warning
Date: Fri, 29 Dec 2017 17:34:54 +0000	[thread overview]
Message-ID: <20171229173454.0533ec34@archlinux> (raw)
In-Reply-To: <1513663175-25163-1-git-send-email-me@tobin.cc>

On Tue, 19 Dec 2017 16:59:35 +1100
"Tobin C. Harding" <me@tobin.cc> wrote:

> When building kernel documentation sphinx emits the following warnings
> 
> No description found for parameter 'iio_dev'
> Excess function parameter 'indio_dev' description in 'iio_device_register'
> 
> These warnings are caused by a macro with a different argument identifier to the
> one listed in the kernel-docs.
> 
> Change macro argument to be the same as the docs.
> 
> Signed-off-by: Tobin C. Harding <me@tobin.cc>

Applied to the togreg branch of iio.git and pushed out as testing
for the autobuilders to play with it.

Thanks,

Jonathan

> ---
>  include/linux/iio/iio.h | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/include/linux/iio/iio.h b/include/linux/iio/iio.h
> index 20b61347ea58..1234e5571d45 100644
> --- a/include/linux/iio/iio.h
> +++ b/include/linux/iio/iio.h
> @@ -606,8 +606,8 @@ const struct iio_chan_spec
>   * iio_device_register() - register a device with the IIO subsystem
>   * @indio_dev:		Device structure filled by the device driver
>   **/
> -#define iio_device_register(iio_dev) \
> -	__iio_device_register((iio_dev), THIS_MODULE)
> +#define iio_device_register(indio_dev) \
> +	__iio_device_register((indio_dev), THIS_MODULE)
>  int __iio_device_register(struct iio_dev *indio_dev, struct module *this_mod);
>  void iio_device_unregister(struct iio_dev *indio_dev);
>  /**


      reply	other threads:[~2017-12-29 17:34 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-12-19  5:59 [PATCH] iio: fix SPHINX kernel-docs build warning Tobin C. Harding
2017-12-29 17:34 ` Jonathan Cameron [this message]

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=20171229173454.0533ec34@archlinux \
    --to=jic23@kernel.org \
    --cc=knaack.h@gmx.de \
    --cc=lars@metafoo.de \
    --cc=linux-iio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=me@tobin.cc \
    --cc=pmeerw@pmeerw.net \
    /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.