dma-buf: Use recommended structure member reference
authorDaniel Vetter <daniel.vetter@ffwll.ch>
Thu, 29 Dec 2016 20:48:25 +0000 (21:48 +0100)
committerDaniel Vetter <daniel.vetter@ffwll.ch>
Fri, 30 Dec 2016 12:34:16 +0000 (13:34 +0100)
I just learned that &struct_name.member_name works and looks pretty
even. It doesn't (yet) link to the member directly though, which would
be really good for big structures or vfunc tables (where the
per-member kerneldoc tends to be long).

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: David Herrmann <dh.herrmann@gmail.com>
Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
Link: http://patchwork.freedesktop.org/patch/msgid/1483044517-5770-5-git-send-email-daniel.vetter@ffwll.ch
drivers/dma-buf/dma-buf.c
include/linux/dma-buf.h

index ab814af..718f832 100644 (file)
@@ -516,9 +516,8 @@ EXPORT_SYMBOL_GPL(dma_buf_get);
  * Uses file's refcounting done implicitly by fput().
  *
  * 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
- * exported.
+ * operation related to this fd is called. It calls &dma_buf_ops.release vfunc
+ * in turn, and frees the memory allocated for dmabuf when exported.
  */
 void dma_buf_put(struct dma_buf *dmabuf)
 {
index 4d61fc5..bfb3704 100644 (file)
@@ -66,8 +66,8 @@ struct dma_buf_ops {
         * is not the case, and the allocation cannot be moved, it should also
         * fail the attach operation.
         *
-        * Any exporter-private housekeeping data can be stored in the priv
-        * pointer of &dma_buf_attachment structure.
+        * Any exporter-private housekeeping data can be stored in the
+        * &dma_buf_attachment.priv pointer.
         *
         * This callback is optional.
         *
@@ -106,7 +106,7 @@ struct dma_buf_ops {
         *
         * Note that any specific buffer attributes required for this function
         * should get added to device_dma_parameters accessible via
-        * device->dma_params from the &dma_buf_attachment. The @attach callback
+        * &device.dma_params from the &dma_buf_attachment. The @attach callback
         * should also check these constraints.
         *
         * If this is being called for the first time, the exporter can now