2020-04-30 02:01:20

by Vitor Massaru Iha

[permalink] [raw]
Subject: [PATCH] dma-buf: Documentation: fix: `make htmldocs` warnings

Add missed ":" on kernel-doc function parameter.

This patch fixes this warnings from `make htmldocs`:
./drivers/dma-buf/dma-buf.c:678: warning: Function parameter or member 'importer_ops' not described in 'dma_buf_dynamic_attach'
./drivers/dma-buf/dma-buf.c:678: warning: Function parameter or member 'importer_priv' not described in 'dma_buf_dynamic_attach'

Signed-off-by: Vitor Massaru Iha <[email protected]>
---
drivers/dma-buf/dma-buf.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/dma-buf/dma-buf.c b/drivers/dma-buf/dma-buf.c
index ccc9eda1bc28..0756d2155745 100644
--- a/drivers/dma-buf/dma-buf.c
+++ b/drivers/dma-buf/dma-buf.c
@@ -655,8 +655,8 @@ EXPORT_SYMBOL_GPL(dma_buf_put);
* calls attach() of dma_buf_ops to allow device-specific attach functionality
* @dmabuf: [in] buffer to attach device to.
* @dev: [in] device to be attached.
- * @importer_ops [in] importer operations for the attachment
- * @importer_priv [in] importer private pointer for the attachment
+ * @importer_ops: [in] importer operations for the attachment
+ * @importer_priv: [in] importer private pointer for the attachment
*
* Returns struct dma_buf_attachment pointer for this attachment. Attachments
* must be cleaned up by calling dma_buf_detach().
--
2.25.1


2020-04-30 02:08:54

by Randy Dunlap

[permalink] [raw]
Subject: Re: [PATCH] dma-buf: Documentation: fix: `make htmldocs` warnings

On 4/29/20 6:59 PM, Vitor Massaru Iha wrote:
> Add missed ":" on kernel-doc function parameter.
>
> This patch fixes this warnings from `make htmldocs`:
> ./drivers/dma-buf/dma-buf.c:678: warning: Function parameter or member 'importer_ops' not described in 'dma_buf_dynamic_attach'
> ./drivers/dma-buf/dma-buf.c:678: warning: Function parameter or member 'importer_priv' not described in 'dma_buf_dynamic_attach'
>
> Signed-off-by: Vitor Massaru Iha <[email protected]>
> ---
> drivers/dma-buf/dma-buf.c | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/drivers/dma-buf/dma-buf.c b/drivers/dma-buf/dma-buf.c
> index ccc9eda1bc28..0756d2155745 100644
> --- a/drivers/dma-buf/dma-buf.c
> +++ b/drivers/dma-buf/dma-buf.c
> @@ -655,8 +655,8 @@ EXPORT_SYMBOL_GPL(dma_buf_put);
> * calls attach() of dma_buf_ops to allow device-specific attach functionality
> * @dmabuf: [in] buffer to attach device to.
> * @dev: [in] device to be attached.
> - * @importer_ops [in] importer operations for the attachment
> - * @importer_priv [in] importer private pointer for the attachment
> + * @importer_ops: [in] importer operations for the attachment
> + * @importer_priv: [in] importer private pointer for the attachment
> *
> * Returns struct dma_buf_attachment pointer for this attachment. Attachments
> * must be cleaned up by calling dma_buf_detach().
>

Sumit said that he would be applying my patch from April 7:
https://lore.kernel.org/linux-media/[email protected]/

thanks.
--
~Randy

2020-04-30 02:32:42

by Vitor Massaru Iha

[permalink] [raw]
Subject: Re: [PATCH] dma-buf: Documentation: fix: `make htmldocs` warnings

On Wed, 2020-04-29 at 19:06 -0700, Randy Dunlap wrote:
> On 4/29/20 6:59 PM, Vitor Massaru Iha wrote:
> > Add missed ":" on kernel-doc function parameter.
> >
> > This patch fixes this warnings from `make htmldocs`:
> > ./drivers/dma-buf/dma-buf.c:678: warning: Function parameter or
> > member 'importer_ops' not described in 'dma_buf_dynamic_attach'
> > ./drivers/dma-buf/dma-buf.c:678: warning: Function parameter or
> > member 'importer_priv' not described in 'dma_buf_dynamic_attach'
> >
> > Signed-off-by: Vitor Massaru Iha <[email protected]>
> > ---
> > drivers/dma-buf/dma-buf.c | 4 ++--
> > 1 file changed, 2 insertions(+), 2 deletions(-)
> >
> > diff --git a/drivers/dma-buf/dma-buf.c b/drivers/dma-buf/dma-buf.c
> > index ccc9eda1bc28..0756d2155745 100644
> > --- a/drivers/dma-buf/dma-buf.c
> > +++ b/drivers/dma-buf/dma-buf.c
> > @@ -655,8 +655,8 @@ EXPORT_SYMBOL_GPL(dma_buf_put);
> > * calls attach() of dma_buf_ops to allow device-specific attach
> > functionality
> > * @dmabuf: [in] buffer to attach device to.
> > * @dev: [in] device to be attached.
> > - * @importer_ops [in] importer operations for the
> > attachment
> > - * @importer_priv [in] importer private pointer for the
> > attachment
> > + * @importer_ops: [in] importer operations for the
> > attachment
> > + * @importer_priv: [in] importer private pointer for the
> > attachment
> > *
> > * Returns struct dma_buf_attachment pointer for this attachment.
> > Attachments
> > * must be cleaned up by calling dma_buf_detach().
> >
>
> Sumit said that he would be applying my patch from April 7:
> https://lore.kernel.org/linux-media/[email protected]/
>
> thanks.

Sorry. I didn't check if the patch has already been sent.

2020-04-30 04:41:39

by Sam Ravnborg

[permalink] [raw]
Subject: Re: [PATCH] dma-buf: Documentation: fix: `make htmldocs` warnings

On Wed, Apr 29, 2020 at 11:27:22PM -0300, Vitor Massaru Iha wrote:
> On Wed, 2020-04-29 at 19:06 -0700, Randy Dunlap wrote:
> > On 4/29/20 6:59 PM, Vitor Massaru Iha wrote:
> > > Add missed ":" on kernel-doc function parameter.
> > >
> > > This patch fixes this warnings from `make htmldocs`:
> > > ./drivers/dma-buf/dma-buf.c:678: warning: Function parameter or
> > > member 'importer_ops' not described in 'dma_buf_dynamic_attach'
> > > ./drivers/dma-buf/dma-buf.c:678: warning: Function parameter or
> > > member 'importer_priv' not described in 'dma_buf_dynamic_attach'
> > >
> > > Signed-off-by: Vitor Massaru Iha <[email protected]>
> > > ---
> > > drivers/dma-buf/dma-buf.c | 4 ++--
> > > 1 file changed, 2 insertions(+), 2 deletions(-)
> > >
> > > diff --git a/drivers/dma-buf/dma-buf.c b/drivers/dma-buf/dma-buf.c
> > > index ccc9eda1bc28..0756d2155745 100644
> > > --- a/drivers/dma-buf/dma-buf.c
> > > +++ b/drivers/dma-buf/dma-buf.c
> > > @@ -655,8 +655,8 @@ EXPORT_SYMBOL_GPL(dma_buf_put);
> > > * calls attach() of dma_buf_ops to allow device-specific attach
> > > functionality
> > > * @dmabuf: [in] buffer to attach device to.
> > > * @dev: [in] device to be attached.
> > > - * @importer_ops [in] importer operations for the
> > > attachment
> > > - * @importer_priv [in] importer private pointer for the
> > > attachment
> > > + * @importer_ops: [in] importer operations for the
> > > attachment
> > > + * @importer_priv: [in] importer private pointer for the
> > > attachment
> > > *
> > > * Returns struct dma_buf_attachment pointer for this attachment.
> > > Attachments
> > > * must be cleaned up by calling dma_buf_detach().
> > >
> >
> > Sumit said that he would be applying my patch from April 7:
> > https://lore.kernel.org/linux-media/[email protected]/
> >
> > thanks.
>
> Sorry. I didn't check if the patch has already been sent.

Sumit - patch from Randy is neither applied to drm-misc-next nor
drm-misc-fixes.
A reminder in case it was lost somewhere.

Sam

2020-04-30 14:23:44

by Sumit Semwal

[permalink] [raw]
Subject: Re: [PATCH] dma-buf: Documentation: fix: `make htmldocs` warnings

Hello Everyone,

On Thu, 30 Apr 2020 at 10:07, Sam Ravnborg <[email protected]> wrote:
>
> On Wed, Apr 29, 2020 at 11:27:22PM -0300, Vitor Massaru Iha wrote:
> > On Wed, 2020-04-29 at 19:06 -0700, Randy Dunlap wrote:
> > > On 4/29/20 6:59 PM, Vitor Massaru Iha wrote:
> > > > Add missed ":" on kernel-doc function parameter.
> > > >
> > > > This patch fixes this warnings from `make htmldocs`:
> > > > ./drivers/dma-buf/dma-buf.c:678: warning: Function parameter or
> > > > member 'importer_ops' not described in 'dma_buf_dynamic_attach'
> > > > ./drivers/dma-buf/dma-buf.c:678: warning: Function parameter or
> > > > member 'importer_priv' not described in 'dma_buf_dynamic_attach'
> > > >
> > > > Signed-off-by: Vitor Massaru Iha <[email protected]>
> > > > ---
> > > > drivers/dma-buf/dma-buf.c | 4 ++--
> > > > 1 file changed, 2 insertions(+), 2 deletions(-)
> > > >
> > > > diff --git a/drivers/dma-buf/dma-buf.c b/drivers/dma-buf/dma-buf.c
> > > > index ccc9eda1bc28..0756d2155745 100644
> > > > --- a/drivers/dma-buf/dma-buf.c
> > > > +++ b/drivers/dma-buf/dma-buf.c
> > > > @@ -655,8 +655,8 @@ EXPORT_SYMBOL_GPL(dma_buf_put);
> > > > * calls attach() of dma_buf_ops to allow device-specific attach
> > > > functionality
> > > > * @dmabuf: [in] buffer to attach device to.
> > > > * @dev: [in] device to be attached.
> > > > - * @importer_ops [in] importer operations for the
> > > > attachment
> > > > - * @importer_priv [in] importer private pointer for the
> > > > attachment
> > > > + * @importer_ops: [in] importer operations for the
> > > > attachment
> > > > + * @importer_priv: [in] importer private pointer for the
> > > > attachment
> > > > *
> > > > * Returns struct dma_buf_attachment pointer for this attachment.
> > > > Attachments
> > > > * must be cleaned up by calling dma_buf_detach().
> > > >
> > >
> > > Sumit said that he would be applying my patch from April 7:
> > > https://lore.kernel.org/linux-media/[email protected]/
> > >
> > > thanks.
> >
> > Sorry. I didn't check if the patch has already been sent.
>
> Sumit - patch from Randy is neither applied to drm-misc-next nor
> drm-misc-fixes.
> A reminder in case it was lost somewhere.

My bad: I have now applied it to drm-misc-fixes, so should be seen in
-next soon.

>
> Sam

Best,
Sumit.