LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: Rob Herring <robh+dt@kernel.org>
Cc: "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
	Frank Rowand <frowand.list@gmail.com>,
	devicetree@vger.kernel.org
Subject: Re: [PATCH 01/10] of: device: Fix function name in header and demote kernel-doc abuse
Date: Fri, 12 Mar 2021 15:07:08 +0000	[thread overview]
Message-ID: <20210312150708.GU701493@dell> (raw)
In-Reply-To: <CAL_JsqKfK2AHdcDKbAQqTiDHTMTH5RiChZGrVhtwj=hed6syNg@mail.gmail.com>

On Fri, 12 Mar 2021, Rob Herring wrote:

> On Fri, Mar 12, 2021 at 4:08 AM Lee Jones <lee.jones@linaro.org> wrote:
> >
> > Fixes the following W=1 kernel build warning(s):
> >
> >  drivers/of/device.c:72: warning: expecting prototype for of_dma_configure(). Prototype was for of_dma_configure_id() instead
> >  drivers/of/device.c:263: warning: Function parameter or member 'dev' not described in 'of_device_modalias'
> >  drivers/of/device.c:263: warning: Function parameter or member 'str' not described in 'of_device_modalias'
> >  drivers/of/device.c:263: warning: Function parameter or member 'len' not described in 'of_device_modalias'
> >  drivers/of/device.c:280: warning: Function parameter or member 'dev' not described in 'of_device_uevent'
> >  drivers/of/device.c:280: warning: Function parameter or member 'env' not described in 'of_device_uevent'
> >
> > Cc: Rob Herring <robh+dt@kernel.org>
> > Cc: Frank Rowand <frowand.list@gmail.com>
> > Cc: devicetree@vger.kernel.org
> > Signed-off-by: Lee Jones <lee.jones@linaro.org>
> > ---
> >  drivers/of/device.c | 6 +++---
> >  1 file changed, 3 insertions(+), 3 deletions(-)
> >
> > diff --git a/drivers/of/device.c b/drivers/of/device.c
> > index 6cb86de404f1c..64ee363abde24 100644
> > --- a/drivers/of/device.c
> > +++ b/drivers/of/device.c
> > @@ -53,7 +53,7 @@ int of_device_add(struct platform_device *ofdev)
> >  }
> >
> >  /**
> > - * of_dma_configure - Setup DMA configuration
> > + * of_dma_configure_id - Setup DMA configuration
> >   * @dev:       Device to apply DMA configuration
> >   * @np:                Pointer to OF node having DMA configuration
> >   * @force_dma:  Whether device is to be set up by of_dma_configure() even if
> > @@ -256,7 +256,7 @@ int of_device_request_module(struct device *dev)
> >  }
> >  EXPORT_SYMBOL_GPL(of_device_request_module);
> >
> > -/**
> > +/*
> 
> We should fix the kerneldoc on public functions. Demoting is fine on
> static or internal to the DT code.

This file is not referenced by Kernel-Doc.

  `git grep kernel-doc:: | grep drivers/of`

> >   * of_device_modalias - Fill buffer with newline terminated modalias string
> >   */
> >  ssize_t of_device_modalias(struct device *dev, char *str, ssize_t len)
> > @@ -273,7 +273,7 @@ ssize_t of_device_modalias(struct device *dev, char *str, ssize_t len)
> >  }
> >  EXPORT_SYMBOL_GPL(of_device_modalias);
> >
> > -/**
> > +/*
> >   * of_device_uevent - Display OF related uevent information
> >   */
> >  void of_device_uevent(struct device *dev, struct kobj_uevent_env *env)
> >

-- 
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog

  reply	other threads:[~2021-03-12 15:07 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-12 11:07 [PATCH 00/10] Rid W=1 warnings from OF Lee Jones
2021-03-12 11:07 ` [PATCH 01/10] of: device: Fix function name in header and demote kernel-doc abuse Lee Jones
2021-03-12 14:54   ` Rob Herring
2021-03-12 15:07     ` Lee Jones [this message]
2021-03-12 11:07 ` [PATCH 02/10] of: dynamic: Fix incorrect parameter name " Lee Jones
2021-03-12 11:07 ` [PATCH 03/10] of: platform: Demote " Lee Jones
2021-03-12 11:07 ` [PATCH 04/10] of: base: Fix some formatting issues and demote non-conformant kernel-doc headers Lee Jones
2021-03-12 11:07 ` [PATCH 05/10] of: property: Provide missing member description and remove excess param Lee Jones
2021-03-12 11:07 ` [PATCH 06/10] of: address: Demote non-conformant kernel-doc header Lee Jones
2021-03-12 11:07 ` [PATCH 07/10] of: fdt: Demote kernel-doc abuses Lee Jones
2021-03-12 15:01   ` Rob Herring
2021-03-12 15:09     ` Lee Jones
2021-03-12 11:07 ` [PATCH 08/10] of: of_net: Demote non-conforming kernel-doc header Lee Jones
2021-03-12 14:05   ` Andrew Lunn
2021-03-12 15:18     ` Lee Jones
2021-03-12 11:07 ` [PATCH 09/10] of: overlay: Fix function name disparity Lee Jones
2021-03-12 11:07 ` [PATCH 10/10] of: of_reserved_mem: Demote kernel-doc abuses Lee Jones

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=20210312150708.GU701493@dell \
    --to=lee.jones@linaro.org \
    --cc=devicetree@vger.kernel.org \
    --cc=frowand.list@gmail.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=robh+dt@kernel.org \
    --subject='Re: [PATCH 01/10] of: device: Fix function name in header and demote kernel-doc abuse' \
    /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

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).