| Message ID | 7bcbe6fe-0b4b-87da-d003-b68a26eb4cf0@infradead.org (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | [-next] dma-buf: fix documentation build warnings | expand |
Hello Randy, On Wed, 8 Apr 2020 at 09:50, Randy Dunlap <rdunlap@infradead.org> wrote: > > From: Randy Dunlap <rdunlap@infradead.org> > > Fix documentation warnings in dma-buf.[hc]: Thank you for your patch; I will apply it to drm-misc tree. > > ../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' > ../include/linux/dma-buf.h:339: warning: Incorrect use of kernel-doc format: * @move_notify > > Signed-off-by: Randy Dunlap <rdunlap@infradead.org> > Cc: Sumit Semwal <sumit.semwal@linaro.org> > Cc: linux-media@vger.kernel.org > Cc: dri-devel@lists.freedesktop.org > Cc: linaro-mm-sig@lists.linaro.org > --- > drivers/dma-buf/dma-buf.c | 4 ++-- > include/linux/dma-buf.h | 3 +-- > 2 files changed, 3 insertions(+), 4 deletions(-) > > --- linux-next-20200407.orig/drivers/dma-buf/dma-buf.c > +++ linux-next-20200407/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(). > --- linux-next-20200407.orig/include/linux/dma-buf.h > +++ linux-next-20200407/include/linux/dma-buf.h > @@ -329,13 +329,12 @@ struct dma_buf { > > /** > * struct dma_buf_attach_ops - importer operations for an attachment > - * @move_notify: [optional] notification that the DMA-buf is moving > * > * Attachment operations implemented by the importer. > */ > struct dma_buf_attach_ops { > /** > - * @move_notify > + * @move_notify: [optional] notification that the DMA-buf is moving > * > * If this callback is provided the framework can avoid pinning the > * backing store while mappings exists. > Best, Sumit.
--- linux-next-20200407.orig/drivers/dma-buf/dma-buf.c +++ linux-next-20200407/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(). --- linux-next-20200407.orig/include/linux/dma-buf.h +++ linux-next-20200407/include/linux/dma-buf.h @@ -329,13 +329,12 @@ struct dma_buf { /** * struct dma_buf_attach_ops - importer operations for an attachment - * @move_notify: [optional] notification that the DMA-buf is moving * * Attachment operations implemented by the importer. */ struct dma_buf_attach_ops { /** - * @move_notify + * @move_notify: [optional] notification that the DMA-buf is moving * * If this callback is provided the framework can avoid pinning the * backing store while mappings exists.