diff mbox

Documentation/dma-buf-sharing.txt: update API descriptions

Message ID 1399895292-29520-1-git-send-email-gioh.kim@lge.com (mailing list archive)
State New, archived
Headers show

Commit Message

??? May 12, 2014, 11:48 a.m. UTC
From: "gioh.kim" <gioh.kim@lge.com>

update some descriptions for API arguments and descriptions.

Signed-off-by: Gioh Kim <gioh.kim@lge.com>
---
 Documentation/dma-buf-sharing.txt |   10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

Comments

Thierry Reding May 13, 2014, 8:44 a.m. UTC | #1
On Mon, May 12, 2014 at 08:48:12PM +0900, gioh.kim wrote:
> From: "gioh.kim" <gioh.kim@lge.com>

It might be good to fix your setup to make this be the same as the name
and email used in the Signed-off-by line below.

> update some descriptions for API arguments and descriptions.

Nit: "Update" since it's the beginning of a sentence.

> Signed-off-by: Gioh Kim <gioh.kim@lge.com>
> ---
>  Documentation/dma-buf-sharing.txt |   10 ++++++----
>  1 file changed, 6 insertions(+), 4 deletions(-)
> 
> diff --git a/Documentation/dma-buf-sharing.txt b/Documentation/dma-buf-sharing.txt
> index 505e711..1ea89b8 100644
> --- a/Documentation/dma-buf-sharing.txt
> +++ b/Documentation/dma-buf-sharing.txt
> @@ -56,7 +56,7 @@ The dma_buf buffer sharing API usage contains the following steps:
>  				     size_t size, int flags,
>  				     const char *exp_name)
>  
> -   If this succeeds, dma_buf_export allocates a dma_buf structure, and returns a
> +   If this succeeds, dma_buf_export_named allocates a dma_buf structure, and returns a

Perhaps reformat this so that the lines don't exceed 80 characters?

>     pointer to the same. It also associates an anonymous file with this buffer,
>     so it can be exported. On failure to allocate the dma_buf object, it returns
>     NULL.
> @@ -66,7 +66,7 @@ The dma_buf buffer sharing API usage contains the following steps:
>  
>     Exporting modules which do not wish to provide any specific name may use the
>     helper define 'dma_buf_export()', with the same arguments as above, but
> -   without the last argument; a __FILE__ pre-processor directive will be
> +   without the last argument; a KBUILD_MODNAME pre-processor directive will be
>     inserted in place of 'exp_name' instead.

This was already fixed in commit 2e33def0339c (dma-buf: update exp_name
when using dma_buf_export()). Perhaps you should rebase this patch on
top of the latest linux-next.

Otherwise looks good.

Thierry
??? May 13, 2014, 11:53 p.m. UTC | #2
Thank you for advice.
I will send a fixed patch soon.

> -----Original Message-----
> From: Thierry Reding [mailto:thierry.reding@gmail.com]
> Sent: Tuesday, May 13, 2014 5:45 PM
> To: gioh.kim
> Cc: Sumit Semwal; Randy Dunlap; linux-media@vger.kernel.org; dri-devel@lists.freedesktop.org; linux-
> doc@vger.kernel.org; linux-kernel@vger.kernel.org; gunho.lee@lge.com
> Subject: Re: [PATCH] Documentation/dma-buf-sharing.txt: update API descriptions
> 
> On Mon, May 12, 2014 at 08:48:12PM +0900, gioh.kim wrote:
> > From: "gioh.kim" <gioh.kim@lge.com>
> 
> It might be good to fix your setup to make this be the same as the name
> and email used in the Signed-off-by line below.
> 
> > update some descriptions for API arguments and descriptions.
> 
> Nit: "Update" since it's the beginning of a sentence.
> 
> > Signed-off-by: Gioh Kim <gioh.kim@lge.com>
> > ---
> >  Documentation/dma-buf-sharing.txt |   10 ++++++----
> >  1 file changed, 6 insertions(+), 4 deletions(-)
> >
> > diff --git a/Documentation/dma-buf-sharing.txt b/Documentation/dma-buf-sharing.txt
> > index 505e711..1ea89b8 100644
> > --- a/Documentation/dma-buf-sharing.txt
> > +++ b/Documentation/dma-buf-sharing.txt
> > @@ -56,7 +56,7 @@ The dma_buf buffer sharing API usage contains the following steps:
> >  				     size_t size, int flags,
> >  				     const char *exp_name)
> >
> > -   If this succeeds, dma_buf_export allocates a dma_buf structure, and returns a
> > +   If this succeeds, dma_buf_export_named allocates a dma_buf structure, and returns a
> 
> Perhaps reformat this so that the lines don't exceed 80 characters?
> 
> >     pointer to the same. It also associates an anonymous file with this buffer,
> >     so it can be exported. On failure to allocate the dma_buf object, it returns
> >     NULL.
> > @@ -66,7 +66,7 @@ The dma_buf buffer sharing API usage contains the following steps:
> >
> >     Exporting modules which do not wish to provide any specific name may use the
> >     helper define 'dma_buf_export()', with the same arguments as above, but
> > -   without the last argument; a __FILE__ pre-processor directive will be
> > +   without the last argument; a KBUILD_MODNAME pre-processor directive will be
> >     inserted in place of 'exp_name' instead.
> 
> This was already fixed in commit 2e33def0339c (dma-buf: update exp_name
> when using dma_buf_export()). Perhaps you should rebase this patch on
> top of the latest linux-next.
> 
> Otherwise looks good.
> 
> Thierry

--
To unsubscribe from this list: send the line "unsubscribe linux-media" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/Documentation/dma-buf-sharing.txt b/Documentation/dma-buf-sharing.txt
index 505e711..1ea89b8 100644
--- a/Documentation/dma-buf-sharing.txt
+++ b/Documentation/dma-buf-sharing.txt
@@ -56,7 +56,7 @@  The dma_buf buffer sharing API usage contains the following steps:
 				     size_t size, int flags,
 				     const char *exp_name)
 
-   If this succeeds, dma_buf_export allocates a dma_buf structure, and returns a
+   If this succeeds, dma_buf_export_named allocates a dma_buf structure, and returns a
    pointer to the same. It also associates an anonymous file with this buffer,
    so it can be exported. On failure to allocate the dma_buf object, it returns
    NULL.
@@ -66,7 +66,7 @@  The dma_buf buffer sharing API usage contains the following steps:
 
    Exporting modules which do not wish to provide any specific name may use the
    helper define 'dma_buf_export()', with the same arguments as above, but
-   without the last argument; a __FILE__ pre-processor directive will be
+   without the last argument; a KBUILD_MODNAME pre-processor directive will be
    inserted in place of 'exp_name' instead.
 
 2. Userspace gets a handle to pass around to potential buffer-users
@@ -76,7 +76,7 @@  The dma_buf buffer sharing API usage contains the following steps:
    drivers and/or processes.
 
    Interface:
-      int dma_buf_fd(struct dma_buf *dmabuf)
+      int dma_buf_fd(struct dma_buf *dmabuf, int flags)
 
    This API installs an fd for the anonymous file associated with this buffer;
    returns either 'fd', or error.
@@ -157,7 +157,9 @@  to request use of buffer for allocation.
    "dma_buf->ops->" indirection from the users of this interface.
 
    In struct dma_buf_ops, unmap_dma_buf is defined as
-      void (*unmap_dma_buf)(struct dma_buf_attachment *, struct sg_table *);
+      void (*unmap_dma_buf)(struct dma_buf_attachment *,
+                            struct sg_table *,
+                            enum dma_data_direction);
 
    unmap_dma_buf signifies the end-of-DMA for the attachment provided. Like
    map_dma_buf, this API also must be implemented by the exporter.