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

[Gioh Kim]

Thank you for advice.
I will send a fixed patch soon.

> -----Original Message-----
> From: Thierry Reding [mailto:thierry.reding at gmail.com]
> Sent: Tuesday, May 13, 2014 5:45 PM
> To: gioh.kim
> Cc: Sumit Semwal; Randy Dunlap; linux-media at vger.kernel.org; dri-devel at lists.freedesktop.org; linux-
> doc at vger.kernel.org; linux-kernel at vger.kernel.org; gunho.lee at 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 at 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 at 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