Commit f641d3b5 authored by Daniel Vetter's avatar Daniel Vetter
Browse files

dma-buf: use preferred struct reference in kernel-doc 



sed -e 's/\( \* .*\)struct &\([_a-z]*\)/\1\&struct \2/' -i

Originally I wasnt a friend of this style because I thought a
line-break between the "&struct" and "foo" part would break it. But a
quick test shows that " * &struct \n * foo\n" works pefectly well with
current kernel-doc. So time to mass-apply these changes!

Cc: Sumit Semwal <sumit.semwal@linaro.org>
Cc: Jani Nikula <jani.nikula@linux.intel.com>
Cc: Chris Wilson <chris@chris-wilson.co.uk>
Reviewed-by: default avatarDavid Herrmann <dh.herrmann@gmail.com>
Signed-off-by: default avatarDaniel Vetter <daniel.vetter@intel.com>
Link: http://patchwork.freedesktop.org/patch/msgid/1483044517-5770-4-git-send-email-daniel.vetter@ffwll.ch
parent 05fc0321

drivers/dma-buf/dma-buf.c

+3 −3
Original line number Diff line number Diff line
@@ -128,7 +128,7 @@ static loff_t dma_buf_llseek(struct file *file, loff_t offset, int whence) 
 * DOC: fence polling

 *

 * To support cross-device and cross-driver synchronization of buffer access

 * implicit fences (represented internally in the kernel with struct &fence) can

 * implicit fences (represented internally in the kernel with &struct fence) can

 * be attached to a &dma_buf. The glue for that and a few related things are

 * provided in the &reservation_object structure.

 *
@@ -373,7 +373,7 @@ static inline int is_dma_buf_file(struct file *file) 
 * Additionally, provide a name string for exporter; useful in debugging.

 *

 * @exp_info:	[in]	holds all the export related information provided

 *			by the exporter. see struct &dma_buf_export_info

 *			by the exporter. see &struct dma_buf_export_info

 *			for further details.

 *

 * Returns, on success, a newly created dma_buf object, which wraps the
@@ -517,7 +517,7 @@ EXPORT_SYMBOL_GPL(dma_buf_get); 
 *

 * If, as a result of this call, the refcount becomes 0, the 'release' file

 * operation related to this fd is called. It calls the release operation of

 * struct &dma_buf_ops in turn, and frees the memory allocated for dmabuf when

 * &struct dma_buf_ops in turn, and frees the memory allocated for dmabuf when

 * exported.

 */

void dma_buf_put(struct dma_buf *dmabuf)

include/linux/dma-buf.h

+2 −2
Original line number Diff line number Diff line
@@ -278,7 +278,7 @@ struct dma_buf_ops { 
 * Shared dma buffers are reference counted using dma_buf_put() and

 * get_dma_buf().

 *

 * Device DMA access is handled by the separate struct &dma_buf_attachment.

 * Device DMA access is handled by the separate &struct dma_buf_attachment.

 */

struct dma_buf {

	size_t size;
@@ -355,7 +355,7 @@ struct dma_buf_export_info { 
 * DEFINE_DMA_BUF_EXPORT_INFO - helper macro for exporters

 * @name: export-info name

 *

 * DEFINE_DMA_BUF_EXPORT_INFO macro defines the struct &dma_buf_export_info,

 * DEFINE_DMA_BUF_EXPORT_INFO macro defines the &struct dma_buf_export_info,

 * zeroes it out and pre-populates exp_name in it.

 */

#define DEFINE_DMA_BUF_EXPORT_INFO(name)	\

CRA Git | Maintained and supported by SUSTech CRA and CCSE